Browse code

Revert "replace FFmpeg with Libav in doc/"

This reverts commit f8a45fa1b1764b34d4263eacd93411e8ba0484a4.

Conflicts:

doc/optimization.txt

Michael Niedermayer authored on 2011/03/18 00:55:58
Showing 25 changed files
... ...
@@ -1,7 +1,7 @@
1 1
 @chapter Bitstream Filters
2 2
 @c man begin BITSTREAM FILTERS
3 3
 
4
-When you configure your Libav build, all the supported bitstream
4
+When you configure your FFmpeg build, all the supported bitstream
5 5
 filters are enabled by default. You can list all available ones using
6 6
 the configure option @code{--list-bsfs}.
7 7
 
... ...
@@ -1,4 +1,4 @@
1
-Libav currently uses a custom build system, this text attempts to document
1
+FFmpeg currently uses a custom build system, this text attempts to document
2 2
 some of its obscure features and options.
3 3
 
4 4
 Options to make:
... ...
@@ -1,10 +1,10 @@
1 1
 @chapter Demuxers
2 2
 @c man begin DEMUXERS
3 3
 
4
-Demuxers are configured elements in Libav which allow to read the
4
+Demuxers are configured elements in FFmpeg which allow to read the
5 5
 multimedia streams from a particular type of file.
6 6
 
7
-When you configure your Libav build, all the supported demuxers
7
+When you configure your FFmpeg build, all the supported demuxers
8 8
 are enabled by default. You can list all available ones using the
9 9
 configure option "--list-demuxers".
10 10
 
... ...
@@ -32,12 +32,12 @@ generated by ./configure to understand what is needed.
32 32
 
33 33
 You can use libavcodec or libavformat in your commercial program, but
34 34
 @emph{any patch you make must be published}. The best way to proceed is
35
-to send your patches to the Libav mailing list.
35
+to send your patches to the FFmpeg mailing list.
36 36
 
37 37
 @anchor{Coding Rules}
38 38
 @section Coding Rules
39 39
 
40
-Libav is programmed in the ISO C90 language with a few additional
40
+FFmpeg is programmed in the ISO C90 language with a few additional
41 41
 features from ISO C99, namely:
42 42
 @itemize @bullet
43 43
 @item
... ...
@@ -54,7 +54,7 @@ These features are supported by all compilers we care about, so we will not
54 54
 accept patches to remove their use unless they absolutely do not impair
55 55
 clarity and performance.
56 56
 
57
-All code must compile with GCC 2.95 and GCC 3.3. Currently, Libav also
57
+All code must compile with GCC 2.95 and GCC 3.3. Currently, FFmpeg also
58 58
 compiles with several other compilers, such as the Compaq ccc compiler
59 59
 or Sun Studio 9, and we would like to keep it that way unless it would
60 60
 be exceedingly involved. To ensure compatibility, please do not use any
... ...
@@ -76,7 +76,7 @@ The TAB character is forbidden outside of Makefiles as is any
76 76
 form of trailing whitespace. Commits containing either will be
77 77
 rejected by the Subversion repository.
78 78
 
79
-The main priority in Libav is simplicity and small code size in order to
79
+The main priority in FFmpeg is simplicity and small code size in order to
80 80
 minimize the bug count.
81 81
 
82 82
 Comments: Use the JavaDoc/Doxygen
... ...
@@ -129,7 +129,7 @@ should also be avoided if they don't make the code easier to understand.
129 129
    an "or any later version" clause is also acceptable, but LGPL is
130 130
    preferred.
131 131
 @item
132
-   You must not commit code which breaks Libav! (Meaning unfinished but
132
+   You must not commit code which breaks FFmpeg! (Meaning unfinished but
133 133
    enabled code which breaks compilation or compiles but does not work or
134 134
    breaks the regression tests)
135 135
    You can commit unfinished stuff (for testing etc), but it must be disabled
... ...
@@ -168,7 +168,7 @@ should also be avoided if they don't make the code easier to understand.
168 168
    with functional changes, such commits will be rejected and removed. Every
169 169
    developer has his own indentation style, you should not change it. Of course
170 170
    if you (re)write something, you can use your own style, even though we would
171
-   prefer if the indentation throughout Libav was consistent (Many projects
171
+   prefer if the indentation throughout FFmpeg was consistent (Many projects
172 172
    force a given indentation style - we do not.). If you really need to make
173 173
    indentation changes (try to avoid this), separate them strictly from real
174 174
    changes.
... ...
@@ -253,7 +253,7 @@ keeping it as a logical unit that contains an individual change, even
253 253
 if it spans multiple files. This makes reviewing your patches much easier
254 254
 for us and greatly increases your chances of getting your patch applied.
255 255
 
256
-Use the patcheck tool of Libav to check your patch.
256
+Use the patcheck tool of FFmpeg to check your patch.
257 257
 The tool is located in the tools directory.
258 258
 
259 259
 Run the regression tests before submitting a patch so that you can
... ...
@@ -275,7 +275,7 @@ Your patch will be reviewed on the mailing list. You will likely be asked
275 275
 to make some changes and are expected to send in an improved version that
276 276
 incorporates the requests from the review. This process may go through
277 277
 several iterations. Once your patch is deemed good enough, some developer
278
-will pick it up and commit it to the official Libav tree.
278
+will pick it up and commit it to the official FFmpeg tree.
279 279
 
280 280
 Give us a few days to react. But if some time passes without reaction,
281 281
 send a reminder by email. Your patch should eventually be dealt with.
... ...
@@ -325,7 +325,7 @@ send a reminder by email. Your patch should eventually be dealt with.
325 325
 @item
326 326
     Is the patch a unified diff?
327 327
 @item
328
-    Is the patch against latest Libav git master branch?
328
+    Is the patch against latest FFmpeg git master branch?
329 329
 @item
330 330
     Are you subscribed to ffmpeg-dev?
331 331
     (the list is subscribers only due to spam)
... ...
@@ -374,7 +374,7 @@ send a reminder by email. Your patch should eventually be dealt with.
374 374
     patch easily?
375 375
 @item
376 376
     If you added a new file, did you insert a license header? It should be
377
-    taken from Libav, not randomly copied and pasted from somewhere else.
377
+    taken from FFmpeg, not randomly copied and pasted from somewhere else.
378 378
 @item
379 379
     You should maintain alphabetical order in alphabetically ordered lists as
380 380
     long as doing so does not break API/ABI compatibility.
... ...
@@ -1,10 +1,10 @@
1 1
 @chapter Encoders
2 2
 @c man begin ENCODERS
3 3
 
4
-Encoders are configured elements in Libav which allow the encoding of
4
+Encoders are configured elements in FFmpeg which allow the encoding of
5 5
 multimedia streams.
6 6
 
7
-When you configure your Libav build, all the supported native encoders
7
+When you configure your FFmpeg build, all the supported native encoders
8 8
 are enabled by default. Encoders requiring an external library must be enabled
9 9
 manually via the corresponding @code{--enable-lib} option. You can list all
10 10
 available encoders using the configure option @code{--list-encoders}.
... ...
@@ -1,7 +1,7 @@
1 1
 @chapter Expression Evaluation
2 2
 @c man begin EXPRESSION EVALUATION
3 3
 
4
-When evaluating an arithemetic expression, Libav uses an internal
4
+When evaluating an arithemetic expression, FFmpeg uses an internal
5 5
 formula evaluator, implemented through the @file{libavutil/eval.h}
6 6
 interface.
7 7
 
... ...
@@ -1,8 +1,8 @@
1 1
 \input texinfo @c -*- texinfo -*-
2 2
 
3
-@settitle Libav FAQ
3
+@settitle FFmpeg FAQ
4 4
 @titlepage
5
-@center @titlefont{Libav FAQ}
5
+@center @titlefont{FFmpeg FAQ}
6 6
 @end titlepage
7 7
 
8 8
 @top
... ...
@@ -11,33 +11,33 @@
11 11
 
12 12
 @chapter General Questions
13 13
 
14
-@section When will the next Libav version be released? / Why are Libav releases so few and far between?
14
+@section When will the next FFmpeg version be released? / Why are FFmpeg releases so few and far between?
15 15
 
16
-Like most open source projects Libav suffers from a certain lack of
16
+Like most open source projects FFmpeg suffers from a certain lack of
17 17
 manpower. For this reason the developers have to prioritize the work
18 18
 they do and putting out releases is not at the top of the list, fixing
19 19
 bugs and reviewing patches takes precedence. Please don't complain or
20 20
 request more timely and/or frequent releases unless you are willing to
21 21
 help out creating them.
22 22
 
23
-@section I have a problem with an old version of Libav; where should I report it?
24
-Nowhere. We do not support old Libav versions in any way, we simply lack
23
+@section I have a problem with an old version of FFmpeg; where should I report it?
24
+Nowhere. We do not support old FFmpeg versions in any way, we simply lack
25 25
 the time, motivation and manpower to do so. If you have a problem with an
26
-old version of Libav, upgrade to the latest Subversion snapshot. If you
26
+old version of FFmpeg, upgrade to the latest Subversion snapshot. If you
27 27
 still experience the problem, then you can report it according to the
28 28
 guidelines in @url{http://ffmpeg.org/bugreports.html}.
29 29
 
30
-@section Why doesn't Libav support feature [xyz]?
30
+@section Why doesn't FFmpeg support feature [xyz]?
31 31
 
32
-Because no one has taken on that task yet. Libav development is
32
+Because no one has taken on that task yet. FFmpeg development is
33 33
 driven by the tasks that are important to the individual developers.
34 34
 If there is a feature that is important to you, the best way to get
35 35
 it implemented is to undertake the task yourself or sponsor a developer.
36 36
 
37
-@section Libav does not support codec XXX. Can you include a Windows DLL loader to support it?
37
+@section FFmpeg does not support codec XXX. Can you include a Windows DLL loader to support it?
38 38
 
39 39
 No. Windows DLLs are not portable, bloated and often slow.
40
-Moreover Libav strives to support all codecs natively.
40
+Moreover FFmpeg strives to support all codecs natively.
41 41
 A DLL loader is not conducive to that goal.
42 42
 
43 43
 @section My bug report/mail to ffmpeg-devel/user has not received any replies.
... ...
@@ -55,10 +55,10 @@ libav* from another application.
55 55
 @item You speak about a video having problems on playback but
56 56
 not what you use to play it.
57 57
 @item We have no faint clue what you are talking about besides
58
-that it is related to Libav.
58
+that it is related to FFmpeg.
59 59
 @end itemize
60 60
 
61
-@section Is there a forum for Libav? I do not like mailing lists.
61
+@section Is there a forum for FFmpeg? I do not like mailing lists.
62 62
 
63 63
 You may view our mailing lists with a more forum-alike look here:
64 64
 @url{http://dir.gmane.org/gmane.comp.video.ffmpeg.user},
... ...
@@ -272,7 +272,7 @@ material, and try '-top 0/1' if the result looks really messed-up.
272 272
 
273 273
 @section How can I read DirectShow files?
274 274
 
275
-If you have built Libav with @code{./configure --enable-avisynth}
275
+If you have built FFmpeg with @code{./configure --enable-avisynth}
276 276
 (only possible on MinGW/Cygwin platforms),
277 277
 then you may use any file that DirectShow can read as input.
278 278
 
... ...
@@ -368,11 +368,11 @@ examining all of the vbv_delay values and making complicated computations."
368 368
 
369 369
 @chapter Development
370 370
 
371
-@section Are there examples illustrating how to use the Libav libraries, particularly libavcodec and libavformat?
371
+@section Are there examples illustrating how to use the FFmpeg libraries, particularly libavcodec and libavformat?
372 372
 
373
-Yes. Read the Developers Guide of the Libav documentation. Alternatively,
373
+Yes. Read the Developers Guide of the FFmpeg documentation. Alternatively,
374 374
 examine the source code for one of the many open source projects that
375
-already incorporate Libav at (@url{projects.html}).
375
+already incorporate FFmpeg at (@url{projects.html}).
376 376
 
377 377
 @section Can you support my C compiler XXX?
378 378
 
... ...
@@ -383,14 +383,14 @@ with @code{#ifdef}s related to the compiler.
383 383
 @section Is Microsoft Visual C++ supported?
384 384
 
385 385
 No. Microsoft Visual C++ is not compliant to the C99 standard and does
386
-not - among other things - support the inline assembly used in Libav.
386
+not - among other things - support the inline assembly used in FFmpeg.
387 387
 If you wish to use MSVC++ for your
388 388
 project then you can link the MSVC++ code with libav* as long as
389 389
 you compile the latter with a working C compiler. For more information, see
390
-the @emph{Microsoft Visual C++ compatibility} section in the Libav
390
+the @emph{Microsoft Visual C++ compatibility} section in the FFmpeg
391 391
 documentation.
392 392
 
393
-There have been efforts to make Libav compatible with MSVC++ in the
393
+There have been efforts to make FFmpeg compatible with MSVC++ in the
394 394
 past. However, they have all been rejected as too intrusive, especially
395 395
 since MinGW does the job adequately. None of the core developers
396 396
 work with MSVC++ and thus this item is low priority. Should you find
... ...
@@ -398,13 +398,13 @@ the silver bullet that solves this problem, feel free to shoot it at us.
398 398
 
399 399
 We strongly recommend you to move over from MSVC++ to MinGW tools.
400 400
 
401
-@section Can I use Libav or libavcodec under Windows?
401
+@section Can I use FFmpeg or libavcodec under Windows?
402 402
 
403
-Yes, but the Cygwin or MinGW tools @emph{must} be used to compile Libav.
404
-Read the @emph{Windows} section in the Libav documentation to find more
403
+Yes, but the Cygwin or MinGW tools @emph{must} be used to compile FFmpeg.
404
+Read the @emph{Windows} section in the FFmpeg documentation to find more
405 405
 information.
406 406
 
407
-To get help and instructions for building Libav under Windows, check out
407
+To get help and instructions for building FFmpeg under Windows, check out
408 408
 the FFmpeg Windows Help Forum at
409 409
 @url{http://ffmpeg.arrozcru.org/}.
410 410
 
... ...
@@ -414,7 +414,7 @@ No. These tools are too bloated and they complicate the build.
414 414
 
415 415
 @section Why not rewrite ffmpeg in object-oriented C++?
416 416
 
417
-Libav is already organized in a highly modular manner and does not need to
417
+FFmpeg is already organized in a highly modular manner and does not need to
418 418
 be rewritten in a formal object language. Further, many of the developers
419 419
 favor straight C; it works for them. For more arguments on this matter,
420 420
 read "Programming Religion" at (@url{http://www.tux.org/lkml/#s15}).
... ...
@@ -441,16 +441,16 @@ the compilation failure then you are probably not qualified for this.
441 441
 
442 442
 @section I'm using libavcodec from within my C++ application but the linker complains about missing symbols which seem to be available.
443 443
 
444
-Libav is a pure C project, so to use the libraries within your C++ application
444
+FFmpeg is a pure C project, so to use the libraries within your C++ application
445 445
 you need to explicitly state that you are using a C library. You can do this by
446
-encompassing your Libav includes using @code{extern "C"}.
446
+encompassing your FFmpeg includes using @code{extern "C"}.
447 447
 
448 448
 See @url{http://www.parashift.com/c++-faq-lite/mixing-c-and-cpp.html#faq-32.3}
449 449
 
450 450
 @section I have a file in memory / a API different from *open/*read/ libc how do I use it with libavformat?
451 451
 
452 452
 You have to implement a URLProtocol, see @file{libavformat/file.c} in
453
-Libav and @file{libmpdemux/demux_lavf.c} in MPlayer sources.
453
+FFmpeg and @file{libmpdemux/demux_lavf.c} in MPlayer sources.
454 454
 
455 455
 @section I get "No compatible shell script interpreter found." in MSys.
456 456
 
... ...
@@ -735,7 +735,7 @@ A preset file contains a sequence of @var{option}=@var{value} pairs,
735 735
 one for each line, specifying a sequence of options which would be
736 736
 awkward to specify on the command line. Lines starting with the hash
737 737
 ('#') character are ignored and are used to provide comments. Check
738
-the @file{ffpresets} directory in the Libav source tree for examples.
738
+the @file{ffpresets} directory in the FFmpeg source tree for examples.
739 739
 
740 740
 Preset files are specified with the @code{vpre}, @code{apre},
741 741
 @code{spre}, and @code{fpre} options. The @code{fpre} option takes the
... ...
@@ -997,11 +997,11 @@ file to which you want to add them.
997 997
 @settitle FFmpeg video converter
998 998
 
999 999
 @c man begin SEEALSO
1000
-ffplay(1), ffprobe(1), ffserver(1) and the Libav HTML documentation
1000
+ffplay(1), ffprobe(1), ffserver(1) and the FFmpeg HTML documentation
1001 1001
 @c man end
1002 1002
 
1003 1003
 @c man begin AUTHORS
1004
-The Libav developers
1004
+The FFmpeg developers
1005 1005
 @c man end
1006 1006
 
1007 1007
 @end ignore
... ...
@@ -20,9 +20,9 @@ ffplay [options] @file{input_file}
20 20
 @chapter Description
21 21
 @c man begin DESCRIPTION
22 22
 
23
-FFplay is a very simple and portable media player using the Libav
23
+FFplay is a very simple and portable media player using the FFmpeg
24 24
 libraries and the SDL library. It is mostly used as a testbed for the
25
-various Libav APIs.
25
+various FFmpeg APIs.
26 26
 @c man end
27 27
 
28 28
 @chapter Options
... ...
@@ -169,11 +169,11 @@ Seek to percentage in file corresponding to fraction of width.
169 169
 @settitle FFplay media player
170 170
 
171 171
 @c man begin SEEALSO
172
-ffmpeg(1), ffprobe(1), ffserver(1) and the Libav HTML documentation
172
+ffmpeg(1), ffprobe(1), ffserver(1) and the FFmpeg HTML documentation
173 173
 @c man end
174 174
 
175 175
 @c man begin AUTHORS
176
-The Libav developers
176
+The FFmpeg developers
177 177
 @c man end
178 178
 
179 179
 @end ignore
... ...
@@ -122,11 +122,11 @@ with name "STREAM".
122 122
 @settitle FFprobe media prober
123 123
 
124 124
 @c man begin SEEALSO
125
-ffmpeg(1), ffplay(1), ffserver(1) and the Libav HTML documentation
125
+ffmpeg(1), ffplay(1), ffserver(1) and the FFmpeg HTML documentation
126 126
 @c man end
127 127
 
128 128
 @c man begin AUTHORS
129
-The Libav developers
129
+The FFmpeg developers
130 130
 @c man end
131 131
 
132 132
 @end ignore
... ...
@@ -266,11 +266,11 @@ rather than as a daemon.
266 266
 @c man begin SEEALSO
267 267
 
268 268
 ffmpeg(1), ffplay(1), ffprobe(1), the @file{ffmpeg/doc/ffserver.conf}
269
-example and the Libav HTML documentation
269
+example and the FFmpeg HTML documentation
270 270
 @c man end
271 271
 
272 272
 @c man begin AUTHORS
273
-The Libav developers
273
+The FFmpeg developers
274 274
 @c man end
275 275
 
276 276
 @end ignore
... ...
@@ -88,6 +88,6 @@ can be disabled setting the environment variable
88 88
 @env{FFMPEG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting
89 89
 the environment variable @env{FFMPEG_FORCE_COLOR}.
90 90
 The use of the environment variable @env{NO_COLOR} is deprecated and
91
-will be dropped in a following Libav version.
91
+will be dropped in a following FFmpeg version.
92 92
 
93 93
 @end table
... ...
@@ -92,7 +92,7 @@ Follows a BNF description for the filtergraph syntax:
92 92
 @chapter Audio Filters
93 93
 @c man begin AUDIO FILTERS
94 94
 
95
-When you configure your Libav build, you can disable any of the
95
+When you configure your FFmpeg build, you can disable any of the
96 96
 existing filters using --disable-filters.
97 97
 The configure output will show the audio filters included in your
98 98
 build.
... ...
@@ -155,7 +155,7 @@ tools.
155 155
 @chapter Video Filters
156 156
 @c man begin VIDEO FILTERS
157 157
 
158
-When you configure your Libav build, you can disable any of the
158
+When you configure your FFmpeg build, you can disable any of the
159 159
 existing filters using --disable-filters.
160 160
 The configure output will show the video filters included in your
161 161
 build.
... ...
@@ -531,7 +531,7 @@ format=yuv420p:yuv444p:yuv410p
531 531
 Apply a frei0r effect to the input video.
532 532
 
533 533
 To enable compilation of this filter you need to install the frei0r
534
-header and configure Libav with --enable-frei0r.
534
+header and configure FFmpeg with --enable-frei0r.
535 535
 
536 536
 The filter supports the syntax:
537 537
 @example
... ...
@@ -669,7 +669,7 @@ Pass the video source unchanged to the output.
669 669
 Apply video transform using libopencv.
670 670
 
671 671
 To enable this filter install libopencv library and headers and
672
-configure Libav with --enable-libopencv.
672
+configure FFmpeg with --enable-libopencv.
673 673
 
674 674
 The filter takes the parameters: @var{filter_name}@{:=@}@var{filter_params}.
675 675
 
... ...
@@ -1314,7 +1314,7 @@ timebase. The expression can contain the constants "PI", "E", "PHI",
1314 1314
 Provide a frei0r source.
1315 1315
 
1316 1316
 To enable compilation of this filter you need to install the frei0r
1317
-header and configure Libav with --enable-frei0r.
1317
+header and configure FFmpeg with --enable-frei0r.
1318 1318
 
1319 1319
 The source supports the syntax:
1320 1320
 @example
... ...
@@ -11,13 +11,13 @@
11 11
 
12 12
 @chapter external libraries
13 13
 
14
-Libav can be hooked up with a number of external libraries to add support
14
+FFmpeg can be hooked up with a number of external libraries to add support
15 15
 for more formats. None of them are used by default, their use has to be
16 16
 explicitly requested by passing the appropriate flags to @file{./configure}.
17 17
 
18 18
 @section OpenCORE AMR
19 19
 
20
-Libav can make use of the OpenCORE libraries for AMR-NB
20
+FFmpeg can make use of the OpenCORE libraries for AMR-NB
21 21
 decoding/encoding and AMR-WB decoding.
22 22
 
23 23
 Go to @url{http://sourceforge.net/projects/opencore-amr/} and follow the instructions for
... ...
@@ -27,7 +27,7 @@ installing the libraries. Then pass @code{--enable-libopencore-amrnb} and/or
27 27
 Note that OpenCORE is under the Apache License 2.0 (see
28 28
 @url{http://www.apache.org/licenses/LICENSE-2.0} for details), which is
29 29
 incompatible with the LGPL version 2.1 and GPL version 2. You have to
30
-upgrade Libav's license to LGPL version 3 (or if you have enabled
30
+upgrade FFmpeg's license to LGPL version 3 (or if you have enabled
31 31
 GPL components, GPL version 3) to use it.
32 32
 
33 33
 
... ...
@@ -37,7 +37,7 @@ You can use the @code{-formats} and @code{-codecs} options to have an exhaustive
37 37
 
38 38
 @section File Formats
39 39
 
40
-Libav supports the following file formats through the @code{libavformat}
40
+FFmpeg supports the following file formats through the @code{libavformat}
41 41
 library:
42 42
 
43 43
 @multitable @columnfractions .4 .1 .1 .4
... ...
@@ -751,18 +751,18 @@ Using a cross-compiler is preferred for various reasons.
751 751
 
752 752
 @subsection DJGPP
753 753
 
754
-Libav cannot be compiled because of broken system headers, add
754
+FFmpeg cannot be compiled because of broken system headers, add
755 755
 @code{--extra-cflags=-U__STRICT_ANSI__} to the configure options as a
756 756
 workaround.
757 757
 
758 758
 @section OS/2
759 759
 
760
-For information about compiling Libav on OS/2 see
760
+For information about compiling FFmpeg on OS/2 see
761 761
 @url{http://www.edm2.com/index.php/FFmpeg}.
762 762
 
763 763
 @section Unix-like
764 764
 
765
-Some parts of Libav cannot be built with version 2.15 of the GNU
765
+Some parts of FFmpeg cannot be built with version 2.15 of the GNU
766 766
 assembler which is still provided by a few AMD64 distributions. To
767 767
 make sure your compiler really uses the required version of gas
768 768
 after a binutils upgrade, run:
... ...
@@ -777,7 +777,7 @@ to configure.
777 777
 
778 778
 @subsection BSD
779 779
 
780
-BSD make will not build Libav, you need to install and use GNU Make
780
+BSD make will not build FFmpeg, you need to install and use GNU Make
781 781
 (@file{gmake}).
782 782
 
783 783
 @subsubsection FreeBSD
... ...
@@ -790,7 +790,7 @@ getting the system headers fixed.
790 790
 
791 791
 @subsection (Open)Solaris
792 792
 
793
-GNU Make is required to build Libav, so you have to invoke (@file{gmake}),
793
+GNU Make is required to build FFmpeg, so you have to invoke (@file{gmake}),
794 794
 standard Solaris Make will not work. When building with a non-c99 front-end
795 795
 (gcc, generic suncc) add either @code{--extra-libs=/usr/lib/values-xpg6.o}
796 796
 or @code{--extra-libs=/usr/lib/64/values-xpg6.o} to the configure options
... ...
@@ -808,22 +808,22 @@ bash ./configure
808 808
 MacOS X on PowerPC or ARM (iPhone) requires a preprocessor from
809 809
 @url{http://github.com/yuvi/gas-preprocessor} to build the optimized
810 810
 assembler functions. Just download the Perl script and put it somewhere
811
-in your PATH, Libav's configure will pick it up automatically.
811
+in your PATH, FFmpeg's configure will pick it up automatically.
812 812
 
813 813
 @section Windows
814 814
 
815
-To get help and instructions for building Libav under Windows, check out
815
+To get help and instructions for building FFmpeg under Windows, check out
816 816
 the FFmpeg Windows Help Forum at
817 817
 @url{http://ffmpeg.arrozcru.org/}.
818 818
 
819 819
 @subsection Native Windows compilation
820 820
 
821
-Libav can be built to run natively on Windows using the MinGW tools. Install
821
+FFmpeg can be built to run natively on Windows using the MinGW tools. Install
822 822
 the latest versions of MSYS and MinGW from @url{http://www.mingw.org/}.
823 823
 You can find detailed installation
824 824
 instructions in the download section and the FAQ.
825 825
 
826
-Libav does not build out-of-the-box with the packages the automated MinGW
826
+FFmpeg does not build out-of-the-box with the packages the automated MinGW
827 827
 installer provides. It also requires coreutils to be installed and many other
828 828
 packages updated to the latest version. The minimum version for some packages
829 829
 are listed below:
... ...
@@ -835,7 +835,7 @@ are listed below:
835 835
 @item mingw-runtime 3.15
836 836
 @end itemize
837 837
 
838
-Libav automatically passes @code{-fno-common} to the compiler to work around
838
+FFmpeg automatically passes @code{-fno-common} to the compiler to work around
839 839
 a GCC bug (see @url{http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216}).
840 840
 
841 841
 Within the MSYS shell, configure and make with:
... ...
@@ -866,14 +866,14 @@ Edit the @file{bin/sdl-config} script so that it points to the correct prefix
866 866
 where SDL was installed. Verify that @file{sdl-config} can be launched from
867 867
 the MSYS command line.
868 868
 
869
-@item By using @code{./configure --enable-shared} when configuring Libav,
869
+@item By using @code{./configure --enable-shared} when configuring FFmpeg,
870 870
 you can build libavutil, libavcodec and libavformat as DLLs.
871 871
 
872 872
 @end itemize
873 873
 
874 874
 @subsection Microsoft Visual C++ compatibility
875 875
 
876
-As stated in the FAQ, Libav will not compile under MSVC++. However, if you
876
+As stated in the FAQ, FFmpeg will not compile under MSVC++. However, if you
877 877
 want to use the libav* libraries in your own applications, you can still
878 878
 compile those applications using MSVC++. But the libav* libraries you link
879 879
 to @emph{must} be built with MinGW. However, you will not be able to debug
... ...
@@ -881,13 +881,13 @@ inside the libav* libraries, since MSVC++ does not recognize the debug
881 881
 symbols generated by GCC.
882 882
 We strongly recommend you to move over from MSVC++ to MinGW tools.
883 883
 
884
-This description of how to use the Libav libraries with MSVC++ is based on
884
+This description of how to use the FFmpeg libraries with MSVC++ is based on
885 885
 Microsoft Visual C++ 2005 Express Edition. If you have a different version,
886 886
 you might have to modify the procedures slightly.
887 887
 
888 888
 @subsubsection Using static libraries
889 889
 
890
-Assuming you have just built and installed Libav in @file{/usr/local}.
890
+Assuming you have just built and installed FFmpeg in @file{/usr/local}.
891 891
 
892 892
 @enumerate
893 893
 
... ...
@@ -898,13 +898,13 @@ Application Wizard, uncheck the "Precompiled headers" option.
898 898
 @item Write the source code for your application, or, for testing, just
899 899
 copy the code from an existing sample application into the source file
900 900
 that MSVC++ has already created for you. For example, you can copy
901
-@file{libavformat/output-example.c} from the Libav distribution.
901
+@file{libavformat/output-example.c} from the FFmpeg distribution.
902 902
 
903 903
 @item Open the "Project / Properties" dialog box. In the "Configuration"
904 904
 combo box, select "All Configurations" so that the changes you make will
905 905
 affect both debug and release builds. In the tree view on the left hand
906 906
 side, select "C/C++ / General", then edit the "Additional Include
907
-Directories" setting to contain the path where the Libav includes were
907
+Directories" setting to contain the path where the FFmpeg includes were
908 908
 installed (i.e. @file{c:\msys\1.0\local\include}).
909 909
 Do not add MinGW's include directory here, or the include files will
910 910
 conflict with MSVC's.
... ...
@@ -912,7 +912,7 @@ conflict with MSVC's.
912 912
 @item Still in the "Project / Properties" dialog box, select
913 913
 "Linker / General" from the tree view and edit the
914 914
 "Additional Library Directories" setting to contain the @file{lib}
915
-directory where Libav was installed (i.e. @file{c:\msys\1.0\local\lib}),
915
+directory where FFmpeg was installed (i.e. @file{c:\msys\1.0\local\lib}),
916 916
 the directory where MinGW libs are installed (i.e. @file{c:\mingw\lib}),
917 917
 and the directory where MinGW's GCC libs are installed
918 918
 (i.e. @file{C:\mingw\lib\gcc\mingw32\4.2.1-sjlj}). Then select
... ...
@@ -929,13 +929,13 @@ set to "Multi-threaded DLL".
929 929
 
930 930
 @item Click "OK" to close the "Project / Properties" dialog box.
931 931
 
932
-@item MSVC++ lacks some C99 header files that are fundamental for Libav.
932
+@item MSVC++ lacks some C99 header files that are fundamental for FFmpeg.
933 933
 Get msinttypes from @url{http://code.google.com/p/msinttypes/downloads/list}
934 934
 and install it in MSVC++'s include directory
935 935
 (i.e. @file{C:\Program Files\Microsoft Visual Studio 8\VC\include}).
936 936
 
937 937
 @item MSVC++ also does not understand the @code{inline} keyword used by
938
-Libav, so you must add this line before @code{#include}ing libav*:
938
+FFmpeg, so you must add this line before @code{#include}ing libav*:
939 939
 @example
940 940
 #define inline _inline
941 941
 @end example
... ...
@@ -968,10 +968,10 @@ and run @file{c:\msys\1.0\msys.bat} from there.
968 968
 @item Within the MSYS shell, run @code{lib.exe}. If you get a help message
969 969
 from @file{Microsoft (R) Library Manager}, this means your environment
970 970
 variables are set up correctly, the @file{Microsoft (R) Library Manager}
971
-is on the path and will be used by Libav to create
971
+is on the path and will be used by FFmpeg to create
972 972
 MSVC++-compatible import libraries.
973 973
 
974
-@item Build Libav with
974
+@item Build FFmpeg with
975 975
 
976 976
 @example
977 977
 ./configure --enable-shared --enable-memalign-hack
... ...
@@ -1000,7 +1000,7 @@ of DLL files, but the ones that are actually used to run your application
1000 1000
 are the ones with a major version number in their filenames
1001 1001
 (i.e. @file{avcodec-51.dll}).
1002 1002
 
1003
-Libav headers do not declare global data for Windows DLLs through the usual
1003
+FFmpeg headers do not declare global data for Windows DLLs through the usual
1004 1004
 dllexport/dllimport interface. Such data will be exported properly while
1005 1005
 building, but to use them in your MSVC++ code you will have to edit the
1006 1006
 appropriate headers and mark the data as dllimport. For example, in
... ...
@@ -1014,14 +1014,14 @@ extern __declspec(dllimport) const AVPixFmtDescriptor av_pix_fmt_descriptors[];
1014 1014
 You must use the MinGW cross compilation tools available at
1015 1015
 @url{http://www.mingw.org/}.
1016 1016
 
1017
-Then configure Libav with the following options:
1017
+Then configure FFmpeg with the following options:
1018 1018
 @example
1019 1019
 ./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
1020 1020
 @end example
1021 1021
 (you can change the cross-prefix according to the prefix chosen for the
1022 1022
 MinGW tools).
1023 1023
 
1024
-Then you can easily test Libav with Wine
1024
+Then you can easily test FFmpeg with Wine
1025 1025
 (@url{http://www.winehq.com/}).
1026 1026
 
1027 1027
 @subsection Compilation under Cygwin
... ...
@@ -1055,7 +1055,7 @@ shared libraries:
1055 1055
 ./configure --enable-shared --disable-static --extra-cflags=-fno-reorder-functions
1056 1056
 @end example
1057 1057
 
1058
-If you want to build Libav with additional libraries, download Cygwin
1058
+If you want to build FFmpeg with additional libraries, download Cygwin
1059 1059
 "Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
1060 1060
 @example
1061 1061
 libogg-devel, libvorbis-devel
... ...
@@ -28,9 +28,9 @@ Consult these resources whenever you have problems, they are quite exhaustive.
28 28
 You do not need a special username or password.
29 29
 All you need is to provide a ssh public key to the Git server admin.
30 30
 
31
-What follows now is a basic introduction to Git and some Libav-specific
31
+What follows now is a basic introduction to Git and some FFmpeg-specific
32 32
 guidelines. Read it at least once, if you are granted commit privileges to the
33
-Libav project you are expected to be familiar with these rules.
33
+FFmpeg project you are expected to be familiar with these rules.
34 34
 
35 35
 
36 36
 
... ...
@@ -46,11 +46,11 @@ I. BASICS:
46 46
 
47 47
     git clone git://git.videolan.org/ffmpeg <target>
48 48
 
49
-  This will put the Libav sources into the directory <target>.
49
+  This will put the FFmpeg sources into the directory <target>.
50 50
 
51 51
     git clone git@git.videolan.org:ffmpeg <target>
52 52
 
53
-  This will put the Libav sources into the directory <target> and let
53
+  This will put the FFmpeg sources into the directory <target> and let
54 54
   you push back your changes to the remote repository.
55 55
 
56 56
 
... ...
@@ -72,7 +72,7 @@ I. BASICS:
72 72
 
73 73
   fetches the changes from the main repository and replays your local commits
74 74
   over it. This is required to keep all your local changes at the top of
75
-  Libav's master tree. The master tree will reject pushes with merge commits.
75
+  FFmpeg's master tree. The master tree will reject pushes with merge commits.
76 76
 
77 77
 
78 78
 3. Adding/removing files/directories:
... ...
@@ -1,10 +1,10 @@
1 1
 @chapter Input Devices
2 2
 @c man begin INPUT DEVICES
3 3
 
4
-Input devices are configured elements in Libav which allow to access
4
+Input devices are configured elements in FFmpeg which allow to access
5 5
 the data coming from a multimedia device attached to your system.
6 6
 
7
-When you configure your Libav build, all the supported input devices
7
+When you configure your FFmpeg build, all the supported input devices
8 8
 are enabled by default. You can list all available ones using the
9 9
 configure option "--list-indevs".
10 10
 
... ...
@@ -95,7 +95,7 @@ A JACK input device creates one or more JACK writable clients, one for
95 95
 each audio channel, with name @var{client_name}:input_@var{N}, where
96 96
 @var{client_name} is the name provided by the application, and @var{N}
97 97
 is a number which identifies the channel.
98
-Each writable client will send the acquired data to the Libav input
98
+Each writable client will send the acquired data to the FFmpeg input
99 99
 device.
100 100
 
101 101
 Once you have created one or more JACK readable clients, you need to
... ...
@@ -1,11 +1,11 @@
1
-Libav's bug/patch/feature request tracker manual
2
-================================================
1
+FFmpeg's bug/patch/feature request tracker manual
2
+=================================================
3 3
 
4 4
 NOTE: This is a draft.
5 5
 
6 6
 Overview:
7 7
 ---------
8
-Libav uses Roundup for tracking issues, new issues and changes to
8
+FFmpeg uses Roundup for tracking issues, new issues and changes to
9 9
 existing issues can be done through a web interface and through email.
10 10
 It is possible to subscribe to individual issues by adding yourself to the
11 11
 nosy list or to subscribe to the ffmpeg-issues mailing list which receives
... ...
@@ -60,7 +60,7 @@ critical
60 60
     No feature request can be critical.
61 61
 
62 62
 important
63
-    Bugs which make Libav unusable for a significant number of users, and
63
+    Bugs which make FFmpeg unusable for a significant number of users, and
64 64
     patches fixing them.
65 65
     Examples here might be completely broken MPEG-4 decoding or a build issue
66 66
     on Linux.
... ...
@@ -81,7 +81,7 @@ minor
81 81
 wish
82 82
     Something that is desirable to have but that there is no urgency at
83 83
     all to implement, e.g. something completely cosmetic like a website
84
-    restyle or a personalized doxy template or the Libav logo.
84
+    restyle or a personalized doxy template or the FFmpeg logo.
85 85
     This priority is not valid for bugs.
86 86
 
87 87
 
... ...
@@ -11,10 +11,10 @@
11 11
 
12 12
 @chapter Introduction
13 13
 
14
-Libavfilter is the filtering API of Libav. It is the substitute of the
14
+Libavfilter is the filtering API of FFmpeg. It is the substitute of the
15 15
 now deprecated 'vhooks' and started as a Google Summer of Code project.
16 16
 
17
-Integrating libavfilter into the main Libav repository is a work in
17
+Integrating libavfilter into the main FFmpeg repository is a work in
18 18
 progress. If you wish to try the unfinished development code of
19 19
 libavfilter then check it out from the libavfilter repository into
20 20
 some directory of your choice by:
... ...
@@ -74,7 +74,7 @@ not have video output.
74 74
 
75 75
 @chapter graph2dot
76 76
 
77
-The @file{graph2dot} program included in the Libav @file{tools}
77
+The @file{graph2dot} program included in the FFmpeg @file{tools}
78 78
 directory can be used to parse a filter graph description and issue a
79 79
 corresponding textual representation in the dot language.
80 80
 
... ...
@@ -1,7 +1,7 @@
1 1
 @chapter Metadata
2 2
 @c man begin METADATA
3 3
 
4
-Libav is able to dump metadata from media files into a simple UTF-8-encoded
4
+FFmpeg is able to dump metadata from media files into a simple UTF-8-encoded
5 5
 INI-like text file and then load it back using the metadata muxer/demuxer.
6 6
 
7 7
 The file format is as follows:
... ...
@@ -53,7 +53,7 @@ A ffmetadata file might look like this:
53 53
 ;FFMETADATA1
54 54
 title=bike\\shed
55 55
 ;this is a comment
56
-artist=Libav troll team
56
+artist=FFmpeg troll team
57 57
 
58 58
 [CHAPTER]
59 59
 TIMEBASE=1/1000
... ...
@@ -1,7 +1,7 @@
1
-Libav multithreading methods
1
+FFmpeg multithreading methods
2 2
 ==============================================
3 3
 
4
-Libav provides two methods for multithreading codecs.
4
+FFmpeg provides two methods for multithreading codecs.
5 5
 
6 6
 Slice threading decodes multiple parts of a frame at the same time, using
7 7
 AVCodecContext execute() and execute2().
... ...
@@ -1,10 +1,10 @@
1 1
 @chapter Muxers
2 2
 @c man begin MUXERS
3 3
 
4
-Muxers are configured elements in Libav which allow writing
4
+Muxers are configured elements in FFmpeg which allow writing
5 5
 multimedia streams to a particular type of file.
6 6
 
7
-When you configure your Libav build, all the supported muxers
7
+When you configure your FFmpeg build, all the supported muxers
8 8
 are enabled by default. You can list all available muxers using the
9 9
 configure option @code{--list-muxers}.
10 10
 
... ...
@@ -201,7 +201,7 @@ Inline asm vs. external asm
201 201
 ---------------------------
202 202
 Both inline asm (__asm__("..") in a .c file, handled by a compiler such as gcc)
203 203
 and external asm (.s or .asm files, handled by an assembler such as yasm/nasm)
204
-are accepted in Libav. Which one to use differs per specific case.
204
+are accepted in FFmpeg. Which one to use differs per specific case.
205 205
 
206 206
 - if your code is intended to be inlined in a C function, inline asm is always
207 207
    better, because external asm cannot be inlined
... ...
@@ -1,10 +1,10 @@
1 1
 @chapter Output Devices
2 2
 @c man begin OUTPUT DEVICES
3 3
 
4
-Output devices are configured elements in Libav which allow to write
4
+Output devices are configured elements in FFmpeg which allow to write
5 5
 multimedia data to an output device attached to your system.
6 6
 
7
-When you configure your Libav build, all the supported output devices
7
+When you configure your FFmpeg build, all the supported output devices
8 8
 are enabled by default. You can list all available ones using the
9 9
 configure option "--list-outdevs".
10 10
 
... ...
@@ -1,10 +1,10 @@
1 1
 @chapter Protocols
2 2
 @c man begin PROTOCOLS
3 3
 
4
-Protocols are configured elements in Libav which allow to access
4
+Protocols are configured elements in FFmpeg which allow to access
5 5
 resources which require the use of a particular protocol.
6 6
 
7
-When you configure your Libav build, all the supported protocols are
7
+When you configure your FFmpeg build, all the supported protocols are
8 8
 enabled by default. You can list all available ones using the
9 9
 configure option "--list-protocols".
10 10
 
... ...
@@ -8,9 +8,9 @@ it's a little late for this year's soc (2006).
8 8
 
9 9
 The Goal:
10 10
 Our goal in respect to soc is and must be of course exactly one thing and
11
-that is to improve Libav, to reach this goal, code must
11
+that is to improve FFmpeg, to reach this goal, code must
12 12
 * conform to the development policy and patch submission guidelines
13
-* must improve Libav somehow (faster, smaller, "better",
13
+* must improve FFmpeg somehow (faster, smaller, "better",
14 14
   more codecs supported, fewer bugs, cleaner, ...)
15 15
 
16 16
 for mentors and other developers to help students to reach that goal it is
... ...
@@ -20,5 +20,5 @@ easy reviewable that again leads us to:
20 20
 * separation of cosmetic from non-cosmetic changes (this is almost entirely
21 21
   ignored by mentors and students in soc 2006 which might lead to a suprise
22 22
   when the code will be reviewed at the end before a possible inclusion in
23
-  Libav, individual changes were generally not reviewable due to cosmetics).
23
+  FFmpeg, individual changes were generally not reviewable due to cosmetics).
24 24
 * frequent commits, so that comments can be provided early