summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMichael Niedermayer <michaelni@gmx.at>2011-03-26 02:42:40 +0100
committerMichael Niedermayer <michaelni@gmx.at>2011-03-26 03:06:30 +0100
commit27ef7b1bcd0577e3f5bdfc524b42b0548567be20 (patch)
treedbb243f25cf614d4951ce9352c89befb3526ed23 /doc
parent0bfe349d4a3e2a98c6f4f02fb03d8585e531d850 (diff)
parenteb81cf860cbb23ece082e6a463a2c6ced8c55ead (diff)
Merge remote-tracking branch 'newdev/master'
* newdev/master: mov: set audio service type for AC-3 from bitstream mode in the 'dac3' atom. Get audio_service_type for AC-3 based on bitstream mode in the AC-3 parser and decoder, and vice-versa for the AC-3 encoder. Use audio_service_type to set stream disposition. Add APIchanges entry for audio_service_type. Add audio_service_type field to AVCodecContext for encoding and reporting of the service type in the audio bitstream. configure: in check_ld, place new -l flags before existing ones support @heading, @subheading, @subsubheading, and @subsubsection in texi2pod.pl doc: update build system documentation aacenc: indentation aacenc: fix the side calculation in search_for_ms vp8.c: rename EDGE_* to VP8_EDGE_*. Conflicts: doc/APIchanges libavcodec/avcodec.h libavcodec/version.h libavcodec/vp8.c Merged-by: Michael Niedermayer <michaelni@gmx.at>
Diffstat (limited to 'doc')
-rw-r--r--doc/APIchanges3
-rw-r--r--doc/build_system.txt51
-rw-r--r--doc/fate.txt45
-rw-r--r--doc/ffmpeg.texi22
-rwxr-xr-xdoc/texi2pod.pl6
5 files changed, 106 insertions, 21 deletions
diff --git a/doc/APIchanges b/doc/APIchanges
index 883258da41..c246cef2e1 100644
--- a/doc/APIchanges
+++ b/doc/APIchanges
@@ -12,6 +12,9 @@ libavutil: 2009-03-08
API changes, most recent first:
+2011-03-25 - 34b47d7 - lavc 52.115.0 - AVCodecContext.audio_service_type
+ Add audio_service_type field to AVCodecContext.
+
2011-XX-XX - XXXXXXX - lavu XX.XXX.X - pixfmt.h
Add PIX_FMT_BGR48LE and PIX_FMT_BGR48BE pixel formats
diff --git a/doc/build_system.txt b/doc/build_system.txt
index 8a200695a5..8e6c63ab68 100644
--- a/doc/build_system.txt
+++ b/doc/build_system.txt
@@ -1,11 +1,38 @@
FFmpeg currently uses a custom build system, this text attempts to document
some of its obscure features and options.
-Options to make:
-make V=1 <target>
- Build target with verbosity 1, instead of 1, 2 can be used too
-make SAMPLES=<path to the fate samples> <target>
- specify the path to the fate samples at make time
+Makefile variables:
+
+V
+ Disable the default terse mode, the full command issued by make and its
+ output will be shown on the screen.
+
+DESTDIR
+ Destination directory for the install targets, useful to prepare packages
+ or install Libav in cross-environments.
+
+Makefile targets:
+
+all
+ Default target, builds all the libraries and the executables.
+
+fate
+ Run the fate test suite, note you must have installed it
+
+fate-list
+ Will list all fate/regression test targets
+
+install
+ Install headers, libraries and programs.
+
+libavformat/output-example
+ Build the libavformat basic example.
+
+libavcodec/api-example
+ Build the libavcodec basic example.
+
+libswscale/swscale-test
+ Build the swscale self-test (useful also as example).
Useful standard make commands:
@@ -21,17 +48,3 @@ make -k
continue build in case of errors, this is useful for the regression tests
sometimes but note it will still not run all reg tests.
-
-Targets to make:
-fate-list
- Will list all fate/regression test targets
-
-fate
- Run the fate test suite, note you must have installed it
-
-
-Setting up local fate:
-use the following command to get the fate test samples
-rsync -aL rsync://rsync.mplayerhq.hu:/samples/fate-suite/ fate/fate-suite
-pass --samples=<path to the samples> to configure or pass the path with the
-SAMPLES variable to make
diff --git a/doc/fate.txt b/doc/fate.txt
new file mode 100644
index 0000000000..a074ed1e5d
--- /dev/null
+++ b/doc/fate.txt
@@ -0,0 +1,45 @@
+FATE Automated Testing Environment
+
+FATE provides a regression testsuite that can be run locally or configured
+to send reports to fate.ffmpeg.org.
+In order to run, it needs a large amount of data (samples and references)
+that is provided separately from the actual source distribution.
+
+Use the following command to get the fate test samples
+
+# rsync -aL rsync://rsync.mplayerhq.hu:/samples/fate-suite/ fate/fate-suite
+
+To inform the build system about the testsuite location, pass
+`--samples=<path to the samples>` to configure or set the SAMPLES Make
+variable or the FATE_SAMPLES environment variable to a suitable value.
+
+For information on how to set up FATE to send results to the official FFmpeg
+testing framework, please refer to the following wiki page:
+http://wiki.multimedia.cx/index.php?title=FATE
+
+FATE Makefile targets:
+
+fate-list
+ Will list all fate/regression test targets.
+
+fate
+ Run the FATE test suite (requires the fate-suite dataset).
+
+Fate Makefile variables:
+
+V
+ Verbosity level, can be set to 0, 1 or 2.
+ * 0: show just the test arguments
+ * 1: show just the command used in the test
+ * 2: show everything
+
+SAMPLES
+ Specify or override the path to the FATE samples at make time, it has a
+ meaning only while running the regression tests.
+
+THREADS
+ Specify how many threads to use while running regression tests, it is
+ quite useful to detect thread-related regressions.
+
+Example:
+ make V=1 SAMPLES=/var/fate/samples THREADS=2 fate
diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
index b9b738210e..47ed58bb37 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -586,6 +586,28 @@ Set the ISO 639 language code (3 letters) of the current audio stream.
@table @option
@item -atag @var{fourcc/tag}
Force audio tag/fourcc.
+@item -audio_service_type @var{type}
+Set the type of service that the audio stream contains.
+@table @option
+@item ma
+Main Audio Service (default)
+@item ef
+Effects
+@item vi
+Visually Impaired
+@item hi
+Hearing Impaired
+@item di
+Dialogue
+@item co
+Commentary
+@item em
+Emergency
+@item vo
+Voice Over
+@item ka
+Karaoke
+@end table
@item -absf @var{bitstream_filter}
Bitstream filters available are "dump_extra", "remove_extra", "noise", "mp3comp", "mp3decomp".
@end table
diff --git a/doc/texi2pod.pl b/doc/texi2pod.pl
index aa3273ec1a..84c36ff1e1 100755
--- a/doc/texi2pod.pl
+++ b/doc/texi2pod.pl
@@ -231,10 +231,12 @@ while(<$inf>) {
# Single line command handlers.
- /^\@(?:section|unnumbered|unnumberedsec|center)\s+(.+)$/
+ /^\@(?:section|unnumbered|unnumberedsec|center|heading)\s+(.+)$/
and $_ = "\n=head2 $1\n";
- /^\@subsection\s+(.+)$/
+ /^\@(?:subsection|subheading)\s+(.+)$/
and $_ = "\n=head3 $1\n";
+ /^\@(?:subsubsection|subsubheading)\s+(.+)$/
+ and $_ = "\n=head4 $1\n";
# Block command handlers:
/^\@itemize\s*(\@[a-z]+|\*|-)?/ and do {