git.sesse.net Git - ffmpeg/blob - 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/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 /* 1 - exp(-x) using a 3-order power series */
  40 static double qexpneg(double x)
  41 {
  42     return 1 - 1 / (1 + x * (1 + x / 2 * (1 + x / 3)));
  43 }
  44
  45 TimeFilter *ff_timefilter_new(double time_base,
  46                               double period,
  47                               double bandwidth)
  48 {
  49     TimeFilter *self       = av_mallocz(sizeof(TimeFilter));
  50     double o               = 2 * M_PI * bandwidth * period * time_base;
  51     self->clock_period     = time_base;
  52     self->feedback2_factor = qexpneg(M_SQRT2 * o);
  53     self->feedback3_factor = qexpneg(o * o) / period;
  54     return self;
  55 }
  56
  57 void ff_timefilter_destroy(TimeFilter *self)
  58 {
  59     av_freep(&self);
  60 }
  61
  62 void ff_timefilter_reset(TimeFilter *self)
  63 {
  64     self->count = 0;
  65 }
  66
  67 double ff_timefilter_update(TimeFilter *self, double system_time, double period)
  68 {
  69     self->count++;
  70     if (self->count == 1) {
  71         /// init loop
  72         self->cycle_time = system_time;
  73     } else {
  74         double loop_error;
  75         self->cycle_time += self->clock_period * period;
  76         /// calculate loop error
  77         loop_error = system_time - self->cycle_time;
  78
  79         /// update loop
  80         self->cycle_time   += FFMAX(self->feedback2_factor, 1.0 / self->count) * loop_error;
  81         self->clock_period += self->feedback3_factor * loop_error;
  82     }
  83     return self->cycle_time;
  84 }
  85
  86 double ff_timefilter_eval(TimeFilter *self, double delta)
  87 {
  88     return self->cycle_time + self->clock_period * delta;
  89 }
  90
  91 #ifdef TEST
  92 #include "libavutil/lfg.h"
  93 #define LFG_MAX ((1LL << 32) - 1)
  94
  95 #undef printf
  96
  97 int main(void)
  98 {
  99     AVLFG prng;
 100     double n0, n1;
 101 #define SAMPLES 1000
 102     double ideal[SAMPLES];
 103     double samples[SAMPLES];
 104     double samplet[SAMPLES];
 105 #if 1
 106     for (n0 = 0; n0 < 40; n0 = 2 * n0 + 1) {
 107         for (n1 = 0; n1 < 10; n1 = 2 * n1 + 1) {
 108 #else
 109     {
 110         {
 111             n0 = 7;
 112             n1 = 1;
 113 #endif
 114             double best_error = 1000000000;
 115             double bestpar0   = 1;
 116             double bestpar1   = 1;
 117             int better, i;
 118
 119             av_lfg_init(&prng, 123);
 120             for (i = 0; i < SAMPLES; i++) {
 121                 samplet[i] = 10 + i + (av_lfg_get(&prng) < LFG_MAX/2 ? 0 : 0.999);
 122                 ideal[i]   = samplet[i] + n1 * i / (1000);
 123                 samples[i] = ideal[i] + n0 * (av_lfg_get(&prng) - LFG_MAX / 2) / (LFG_MAX * 10LL);
 124                 if(i && samples[i]<samples[i-1])
 125                     samples[i]=samples[i-1]+0.001;
 126             }
 127
 128             do {
 129                 double par0, par1;
 130                 better = 0;
 131                 for (par0 = bestpar0 * 0.8; par0 <= bestpar0 * 1.21; par0 += bestpar0 * 0.05) {
 132                     for (par1 = bestpar1 * 0.8; par1 <= bestpar1 * 1.21; par1 += bestpar1 * 0.05) {
 133                         double error   = 0;
 134                         TimeFilter *tf = ff_timefilter_new(1, par0, par1);
 135                         for (i = 0; i < SAMPLES; i++) {
 136                             double filtered;
 137                             filtered = ff_timefilter_update(tf, samples[i], i ? (samplet[i] - samplet[i-1]) : 1);
 138                             if(filtered < 0 || filtered > 1000000000)
 139                                 printf("filter is unstable\n");
 140                             error   += (filtered - ideal[i]) * (filtered - ideal[i]);
 141                         }
 142                         ff_timefilter_destroy(tf);
 143                         if (error < best_error) {
 144                             best_error = error;
 145                             bestpar0   = par0;
 146                             bestpar1   = par1;
 147                             better     = 1;
 148                         }
 149                     }
 150                 }
 151             } while (better);
 152 #if 0
 153             double lastfil = 9;
 154             TimeFilter *tf = ff_timefilter_new(1, bestpar0, bestpar1);
 155             for (i = 0; i < SAMPLES; i++) {
 156                 double filtered;
 157                 filtered = ff_timefilter_update(tf, samples[i], 1);
 158                 printf("%f %f %f %f\n", i - samples[i] + 10, filtered - samples[i],
 159                        samples[FFMAX(i, 1)] - samples[FFMAX(i - 1, 0)], filtered - lastfil);
 160                 lastfil = filtered;
 161             }
 162             ff_timefilter_destroy(tf);
 163 #else
 164             printf(" [%f %f %9f]", bestpar0, bestpar1, best_error);
 165 #endif
 166         }
 167         printf("\n");
 168     }
 169     return 0;
 170 }
 171 #endif