~ubuntu-branches/ubuntu/utopic/libav/utopic

« back to all changes in this revision

Viewing changes to doc/optimization.txt

  • Committer: Bazaar Package Importer
  • Author(s): Reinhard Tartler
  • Date: 2011-03-20 12:09:31 UTC
  • Revision ID: james.westby@ubuntu.com-20110320120931-nfhi9tiok27gxhw1
Tags: upstream-0.6.2
ImportĀ upstreamĀ versionĀ 0.6.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
optimization Tips (for libavcodec):
 
2
===================================
 
3
 
 
4
What to optimize:
 
5
-----------------
 
6
If you plan to do non-x86 architecture specific optimizations (SIMD normally),
 
7
then take a look in the x86/ directory, as most important functions are
 
8
already optimized for MMX.
 
9
 
 
10
If you want to do x86 optimizations then you can either try to finetune the
 
11
stuff in the x86 directory or find some other functions in the C source to
 
12
optimize, but there aren't many left.
 
13
 
 
14
 
 
15
Understanding these overoptimized functions:
 
16
--------------------------------------------
 
17
As many functions tend to be a bit difficult to understand because
 
18
of optimizations, it can be hard to optimize them further, or write
 
19
architecture-specific versions. It is recommended to look at older
 
20
revisions of the interesting files (for a web frontend try ViewVC at
 
21
http://svn.ffmpeg.org/ffmpeg/trunk/).
 
22
Alternatively, look into the other architecture-specific versions in
 
23
the x86/, ppc/, alpha/ subdirectories. Even if you don't exactly
 
24
comprehend the instructions, it could help understanding the functions
 
25
and how they can be optimized.
 
26
 
 
27
NOTE: If you still don't understand some function, ask at our mailing list!!!
 
28
(http://lists.mplayerhq.hu/mailman/listinfo/ffmpeg-devel)
 
29
 
 
30
 
 
31
When is an optimization justified?
 
32
----------------------------------
 
33
Normally, clean and simple optimizations for widely used codecs are
 
34
justified even if they only achieve an overall speedup of 0.1%. These
 
35
speedups accumulate and can make a big difference after awhile. Also, if
 
36
none of the following factors get worse due to an optimization -- speed,
 
37
binary code size, source size, source readability -- and at least one
 
38
factor improves, then an optimization is always a good idea even if the
 
39
overall gain is less than 0.1%. For obscure codecs that are not often
 
40
used, the goal is more toward keeping the code clean, small, and
 
41
readable instead of making it 1% faster.
 
42
 
 
43
 
 
44
WTF is that function good for ....:
 
45
-----------------------------------
 
46
The primary purpose of this list is to avoid wasting time optimizing functions
 
47
which are rarely used.
 
48
 
 
49
put(_no_rnd)_pixels{,_x2,_y2,_xy2}
 
50
    Used in motion compensation (en/decoding).
 
51
 
 
52
avg_pixels{,_x2,_y2,_xy2}
 
53
    Used in motion compensation of B-frames.
 
54
    These are less important than the put*pixels functions.
 
55
 
 
56
avg_no_rnd_pixels*
 
57
    unused
 
58
 
 
59
pix_abs16x16{,_x2,_y2,_xy2}
 
60
    Used in motion estimation (encoding) with SAD.
 
61
 
 
62
pix_abs8x8{,_x2,_y2,_xy2}
 
63
    Used in motion estimation (encoding) with SAD of MPEG-4 4MV only.
 
64
    These are less important than the pix_abs16x16* functions.
 
65
 
 
66
put_mspel8_mc* / wmv2_mspel8*
 
67
    Used only in WMV2.
 
68
    it is not recommended that you waste your time with these, as WMV2
 
69
    is an ugly and relatively useless codec.
 
70
 
 
71
mpeg4_qpel* / *qpel_mc*
 
72
    Used in MPEG-4 qpel motion compensation (encoding & decoding).
 
73
    The qpel8 functions are used only for 4mv,
 
74
    the avg_* functions are used only for B-frames.
 
75
    Optimizing them should have a significant impact on qpel
 
76
    encoding & decoding.
 
77
 
 
78
qpel{8,16}_mc??_old_c / *pixels{8,16}_l4
 
79
    Just used to work around a bug in an old libavcodec encoder version.
 
80
    Don't optimize them.
 
81
 
 
82
tpel_mc_func {put,avg}_tpel_pixels_tab
 
83
    Used only for SVQ3, so only optimize them if you need fast SVQ3 decoding.
 
84
 
 
85
add_bytes/diff_bytes
 
86
    For huffyuv only, optimize if you want a faster ffhuffyuv codec.
 
87
 
 
88
get_pixels / diff_pixels
 
89
    Used for encoding, easy.
 
90
 
 
91
clear_blocks
 
92
    easiest to optimize
 
93
 
 
94
gmc
 
95
    Used for MPEG-4 gmc.
 
96
    Optimizing this should have a significant effect on the gmc decoding
 
97
    speed.
 
98
 
 
99
gmc1
 
100
    Used for chroma blocks in MPEG-4 gmc with 1 warp point
 
101
    (there are 4 luma & 2 chroma blocks per macroblock, so
 
102
    only 1/3 of the gmc blocks use this, the other 2/3
 
103
    use the normal put_pixel* code, but only if there is
 
104
    just 1 warp point).
 
105
    Note: DivX5 gmc always uses just 1 warp point.
 
106
 
 
107
pix_sum
 
108
    Used for encoding.
 
109
 
 
110
hadamard8_diff / sse / sad == pix_norm1 / dct_sad / quant_psnr / rd / bit
 
111
    Specific compare functions used in encoding, it depends upon the
 
112
    command line switches which of these are used.
 
113
    Don't waste your time with dct_sad & quant_psnr, they aren't
 
114
    really useful.
 
115
 
 
116
put_pixels_clamped / add_pixels_clamped
 
117
    Used for en/decoding in the IDCT, easy.
 
118
    Note, some optimized IDCTs have the add/put clamped code included and
 
119
    then put_pixels_clamped / add_pixels_clamped will be unused.
 
120
 
 
121
idct/fdct
 
122
    idct (encoding & decoding)
 
123
    fdct (encoding)
 
124
    difficult to optimize
 
125
 
 
126
dct_quantize_trellis
 
127
    Used for encoding with trellis quantization.
 
128
    difficult to optimize
 
129
 
 
130
dct_quantize
 
131
    Used for encoding.
 
132
 
 
133
dct_unquantize_mpeg1
 
134
    Used in MPEG-1 en/decoding.
 
135
 
 
136
dct_unquantize_mpeg2
 
137
    Used in MPEG-2 en/decoding.
 
138
 
 
139
dct_unquantize_h263
 
140
    Used in MPEG-4/H.263 en/decoding.
 
141
 
 
142
FIXME remaining functions?
 
143
BTW, most of these functions are in dsputil.c/.h, some are in mpegvideo.c/.h.
 
144
 
 
145
 
 
146
 
 
147
Alignment:
 
148
Some instructions on some architectures have strict alignment restrictions,
 
149
for example most SSE/SSE2 instructions on x86.
 
150
The minimum guaranteed alignment is written in the .h files, for example:
 
151
    void (*put_pixels_clamped)(const DCTELEM *block/*align 16*/, UINT8 *pixels/*align 8*/, int line_size);
 
152
 
 
153
 
 
154
General Tips:
 
155
-------------
 
156
Use asm loops like:
 
157
__asm__(
 
158
    "1: ....
 
159
    ...
 
160
    "jump_instruciton ....
 
161
Do not use C loops:
 
162
do{
 
163
    __asm__(
 
164
        ...
 
165
}while()
 
166
 
 
167
Use __asm__() instead of intrinsics. The latter requires a good optimizing compiler
 
168
which gcc is not.
 
169
 
 
170
 
 
171
Links:
 
172
======
 
173
http://www.aggregate.org/MAGIC/
 
174
 
 
175
x86-specific:
 
176
-------------
 
177
http://developer.intel.com/design/pentium4/manuals/248966.htm
 
178
 
 
179
The IA-32 Intel Architecture Software Developer's Manual, Volume 2:
 
180
Instruction Set Reference
 
181
http://developer.intel.com/design/pentium4/manuals/245471.htm
 
182
 
 
183
http://www.agner.org/assem/
 
184
 
 
185
AMD Athlon Processor x86 Code Optimization Guide:
 
186
http://www.amd.com/us-en/assets/content_type/white_papers_and_tech_docs/22007.pdf
 
187
 
 
188
 
 
189
ARM-specific:
 
190
-------------
 
191
ARM Architecture Reference Manual (up to ARMv5TE):
 
192
http://www.arm.com/community/university/eulaarmarm.html
 
193
 
 
194
Procedure Call Standard for the ARM Architecture:
 
195
http://www.arm.com/pdfs/aapcs.pdf
 
196
 
 
197
Optimization guide for ARM9E (used in Nokia 770 Internet Tablet):
 
198
http://infocenter.arm.com/help/topic/com.arm.doc.ddi0240b/DDI0240A.pdf
 
199
Optimization guide for ARM11 (used in Nokia N800 Internet Tablet):
 
200
http://infocenter.arm.com/help/topic/com.arm.doc.ddi0211j/DDI0211J_arm1136_r1p5_trm.pdf
 
201
Optimization guide for Intel XScale (used in Sharp Zaurus PDA):
 
202
http://download.intel.com/design/intelxscale/27347302.pdf
 
203
Intel Wireless MMX2 Coprocessor: Programmers Reference Manual
 
204
http://download.intel.com/design/intelxscale/31451001.pdf
 
205
 
 
206
PowerPC-specific:
 
207
-----------------
 
208
PowerPC32/AltiVec PIM:
 
209
www.freescale.com/files/32bit/doc/ref_manual/ALTIVECPEM.pdf
 
210
 
 
211
PowerPC32/AltiVec PEM:
 
212
www.freescale.com/files/32bit/doc/ref_manual/ALTIVECPIM.pdf
 
213
 
 
214
CELL/SPU:
 
215
http://www-01.ibm.com/chips/techlib/techlib.nsf/techdocs/30B3520C93F437AB87257060006FFE5E/$file/Language_Extensions_for_CBEA_2.4.pdf
 
216
http://www-01.ibm.com/chips/techlib/techlib.nsf/techdocs/9F820A5FFA3ECE8C8725716A0062585F/$file/CBE_Handbook_v1.1_24APR2007_pub.pdf
 
217
 
 
218
SPARC-specific:
 
219
---------------
 
220
SPARC Joint Programming Specification (JPS1): Commonality
 
221
http://www.fujitsu.com/downloads/PRMPWR/JPS1-R1.0.4-Common-pub.pdf
 
222
 
 
223
UltraSPARC III Processor User's Manual (contains instruction timings)
 
224
http://www.sun.com/processors/manuals/USIIIv2.pdf
 
225
 
 
226
VIS Whitepaper (contains optimization guidelines)
 
227
http://www.sun.com/processors/vis/download/vis/vis_whitepaper.pdf
 
228
 
 
229
GCC asm links:
 
230
--------------
 
231
official doc but quite ugly
 
232
http://gcc.gnu.org/onlinedocs/gcc/Extended-Asm.html
 
233
 
 
234
a bit old (note "+" is valid for input-output, even though the next disagrees)
 
235
http://www.cs.virginia.edu/~clc5q/gcc-inline-asm.pdf