build: cosmetics: Split HEADERS/OBJS/PROGS lists into one entry per line.
[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/mem.h"
26 #include "config.h"
27 #include "timefilter.h"
28
29 struct TimeFilter {
30     /// Delay Locked Loop data. These variables refer to mathematical
31     /// concepts described in: http://www.kokkinizita.net/papers/usingdll.pdf
32     double cycle_time;
33     double feedback2_factor;
34     double feedback3_factor;
35     double clock_period;
36     int count;
37 };
38
39 TimeFilter *ff_timefilter_new(double clock_period,
40                               double feedback2_factor,
41                               double feedback3_factor)
42 {
43     TimeFilter *self       = av_mallocz(sizeof(TimeFilter));
44     self->clock_period     = clock_period;
45     self->feedback2_factor = feedback2_factor;
46     self->feedback3_factor = feedback3_factor;
47     return self;
48 }
49
50 void ff_timefilter_destroy(TimeFilter *self)
51 {
52     av_freep(&self);
53 }
54
55 void ff_timefilter_reset(TimeFilter *self)
56 {
57     self->count = 0;
58 }
59
60 double ff_timefilter_update(TimeFilter *self, double system_time, double period)
61 {
62     self->count++;
63     if (self->count == 1) {
64         /// init loop
65         self->cycle_time = system_time;
66     } else {
67         double loop_error;
68         self->cycle_time += self->clock_period * period;
69         /// calculate loop error
70         loop_error = system_time - self->cycle_time;
71
72         /// update loop
73         self->cycle_time   += FFMAX(self->feedback2_factor, 1.0 / self->count) * loop_error;
74         self->clock_period += self->feedback3_factor * loop_error / period;
75     }
76     return self->cycle_time;
77 }
78
79 #ifdef TEST
80 #include "libavutil/lfg.h"
81 #define LFG_MAX ((1LL << 32) - 1)
82
83 #undef printf
84
85 int main(void)
86 {
87     AVLFG prng;
88     double n0, n1;
89 #define SAMPLES 1000
90     double ideal[SAMPLES];
91     double samples[SAMPLES];
92 #if 1
93     for (n0 = 0; n0 < 40; n0 = 2 * n0 + 1) {
94         for (n1 = 0; n1 < 10; n1 = 2 * n1 + 1) {
95 #else
96     {
97         {
98             n0 = 7;
99             n1 = 1;
100 #endif
101             double best_error = 1000000000;
102             double bestpar0   = 1;
103             double bestpar1   = 0.001;
104             int better, i;
105
106             av_lfg_init(&prng, 123);
107             for (i = 0; i < SAMPLES; i++) {
108                 ideal[i]   = 10 + i + n1 * i / (1000);
109                 samples[i] = ideal[i] + n0 * (av_lfg_get(&prng) - LFG_MAX / 2) / (LFG_MAX * 10LL);
110             }
111
112             do {
113                 double par0, par1;
114                 better = 0;
115                 for (par0 = bestpar0 * 0.8; par0 <= bestpar0 * 1.21; par0 += bestpar0 * 0.05) {
116                     for (par1 = bestpar1 * 0.8; par1 <= bestpar1 * 1.21; par1 += bestpar1 * 0.05) {
117                         double error   = 0;
118                         TimeFilter *tf = ff_timefilter_new(1, par0, par1);
119                         for (i = 0; i < SAMPLES; i++) {
120                             double filtered;
121                             filtered = ff_timefilter_update(tf, samples[i], 1);
122                             error   += (filtered - ideal[i]) * (filtered - ideal[i]);
123                         }
124                         ff_timefilter_destroy(tf);
125                         if (error < best_error) {
126                             best_error = error;
127                             bestpar0   = par0;
128                             bestpar1   = par1;
129                             better     = 1;
130                         }
131                     }
132                 }
133             } while (better);
134 #if 0
135             double lastfil = 9;
136             TimeFilter *tf = ff_timefilter_new(1, bestpar0, bestpar1);
137             for (i = 0; i < SAMPLES; i++) {
138                 double filtered;
139                 filtered = ff_timefilter_update(tf, samples[i], 1);
140                 printf("%f %f %f %f\n", i - samples[i] + 10, filtered - samples[i],
141                        samples[FFMAX(i, 1)] - samples[FFMAX(i - 1, 0)], filtered - lastfil);
142                 lastfil = filtered;
143             }
144             ff_timefilter_destroy(tf);
145 #else
146             printf(" [%f %f %9f]", bestpar0, bestpar1, best_error);
147 #endif
148         }
149         printf("\n");
150     }
151     return 0;
152 }
153 #endif