Mercurial > libavformat.hg
comparison timefilter.h @ 4650:5090afc3cd19 libavformat
Timefilter code by Olivier Guilyardi o list O samalyse o com
author | michael |
---|---|
date | Thu, 05 Mar 2009 23:45:18 +0000 |
parents | |
children | 28b80bbf6288 |
comparison
equal
deleted
inserted
replaced
4649:fab2e46a5b1a | 4650:5090afc3cd19 |
---|---|
1 /* | |
2 * Delay Locked Loop based time filter prototypes and declarations | |
3 * Copyright (c) 2009 Samalyse | |
4 * Author: Olivier Guilyardi <olivier samalyse com> | |
5 * | |
6 * This file is part of FFmpeg. | |
7 * | |
8 * FFmpeg is free software; you can redistribute it and/or | |
9 * modify it under the terms of the GNU Lesser General Public | |
10 * License as published by the Free Software Foundation; either | |
11 * version 2.1 of the License, or (at your option) any later version. | |
12 * | |
13 * FFmpeg is distributed in the hope that it will be useful, | |
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
16 * Lesser General Public License for more details. | |
17 * | |
18 * You should have received a copy of the GNU Lesser General Public | |
19 * License along with FFmpeg; if not, write to the Free Software | |
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | |
21 */ | |
22 | |
23 #ifndef AVFORMAT_TIMEFILTER_H | |
24 #define AVFORMAT_TIMEFILTER_H | |
25 | |
26 /** | |
27 * Opaque type representing a time filter state | |
28 * | |
29 * The purpose of this filter is to provide a way to compute accurate time | |
30 * stamps that can be compared to wall clock time, especially when dealing | |
31 * with two clocks: the system clock and a hardware device clock, such as | |
32 * a soundcard. | |
33 */ | |
34 typedef struct TimeFilter TimeFilter; | |
35 | |
36 | |
37 /** | |
38 * Create a new Delay Locked Loop time filter | |
39 * | |
40 * period is the device cycle duration in seconds. For example, at | |
41 * 44.1Hz and a buffer size of 512 frames, period = 512 / 44100. The filter | |
42 * only works if the cycle duration is fixed. | |
43 * | |
44 * feedback2_factor and feedback3_factor are the factors used for the | |
45 * multiplications that are respectively performed in the second and third | |
46 * feedback paths of the loop. | |
47 * | |
48 * Unless you know what you are doing, you should set these as follow: | |
49 * | |
50 * o = 2 * M_PI * bandwidth * period | |
51 * feedback2_factor = sqrt(2 * o) | |
52 * feedback3_factor = o * o | |
53 * | |
54 * Where bandwidth is up to you to choose. Smaller values will filter out more | |
55 * of the jitter, but also take a longer time for the loop to settle. A good | |
56 * starting point is something between 0.3 and 3 Hz. | |
57 * | |
58 * For more details about these parameters and background concepts please see: | |
59 * http://www.kokkinizita.net/papers/usingdll.pdf | |
60 */ | |
61 TimeFilter * ff_timefilter_new(double period, double feedback2_factor, double feedback3_factor); | |
62 | |
63 /** | |
64 * Update the filter | |
65 * | |
66 * This function must be called in real time, at each process cycle. | |
67 * | |
68 * system_time, in seconds, should be the value of the system clock time, | |
69 * at (or as close as possible to) the moment the device hardware interrupt | |
70 * occured (or any other event the device clock raises at the beginning of a | |
71 * cycle). | |
72 */ | |
73 void ff_timefilter_update(TimeFilter *self, double system_time); | |
74 | |
75 /** | |
76 * Retrieve the filtered time | |
77 * | |
78 * The returned value represents the filtered time, in seconds, of the | |
79 * beginning of the current cycle as updated by the last call to | |
80 * ff_timefilter_update() | |
81 * | |
82 * This is the value that should be used for timestamping. | |
83 * | |
84 * Warning: you must call ff_timefilter_update() before this, otherwise the | |
85 * result is undetermined. | |
86 */ | |
87 double ff_timefilter_read(TimeFilter *); | |
88 | |
89 /** | |
90 * Reset the filter | |
91 * | |
92 * This function should mainly be called in case of XRUN. | |
93 * | |
94 * Warning: after calling this, the filter is in an undetermined state until | |
95 * the next call to ff_timefilter_update() | |
96 */ | |
97 void ff_timefilter_reset(TimeFilter *); | |
98 | |
99 /** | |
100 * Free all resources associated with the filter | |
101 */ | |
102 void ff_timefilter_destroy(TimeFilter *); | |
103 | |
104 #endif /* AVFORMAT_TIMEFILTER_H */ |