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