Timothy Gu
17ad5fbb8a
Use makeinfo to generate html doc for the new website
...
texi2html is deprecated by upstream in favor of makeinfo/texi2any. See:
- https://www.gnu.org/software/texinfo/manual/texinfo/html_node/texi2html.html
- https://wiki.debian.org/Texi2htmlTransition
- https://lists.debian.org/debian-devel/2013/05/msg01516.html
This is actually two separate changes.
Based on a patch by Andreas Cadhalpun <Andreas.Cadhalpun@googlemail.com>.
Fixes Trac ticket #3232 .
Signed-off-by: Timothy Gu <timothygu99@gmail.com>
10 years ago
Rong Yan
6abeaf2781
build sys: enable the decoding_encoding example under the ffmpeg/doc/examples
...
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
10 years ago
Clément Bœsch
b0352b1997
avcodec: export motion vectors in frame side data on demand
...
The reasoning behind this addition is that various third party
applications are interested in getting some motion information out of a
video "for free" when it is available.
It was considered to export other information as well (such as the intra
information about the block, or the quantization) but the structure
might have ended up into a half full-generic, half full of codec
specific cruft. If more information is necessary, it should either be
added in the "flags" field of the AVMotionVector structure, or in
another side-data.
This commit also includes an example exporting them in a CSV stream.
10 years ago
Timothy Gu
8e6a66b662
doc: add doxygen target tag
...
Signed-off-by: Timothy Gu <timothygu99@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
11 years ago
Timothy Gu
cee98aadb1
doc: make doxygen program configurable
...
Signed-off-by: Timothy Gu <timothygu99@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
11 years ago
Timothy Gu
865a761081
doc: add doxy-wrapper.sh to doc/doxygen/html dependencies
...
Signed-off-by: Timothy Gu <timothygu99@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
11 years ago
Andrey Utkin
e10ab43614
doc/examples: Add example transcoding.c
...
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
11 years ago
Anton Khirnov
e7dfaf16a4
libavfilter: example audio filtering program
...
Based on a patch by Andrew Kelley <superjoe30@gmail.com>
Signed-off-by: Diego Biurrun <diego@biurrun.de>
11 years ago
Diego Biurrun
b339182eba
Move all example programs to doc/examples
...
Also drop support for building examples in library directories.
11 years ago
Diego Biurrun
3a26ccbf0d
build: doxy: Include code examples in Doxygen documentation
11 years ago
Diego Biurrun
f1f42cfc66
build: Do not pass HTML snippets and stylesheet as input to Doxygen
...
These files are referenced elsewhere and only generate warnings if
presented to Doxygen as input files.
11 years ago
Christophe Gisquet
682b2a809b
build: fix examples compilation when EXESUF is not empty
...
Due to a wrong substitution doc/examples is not added as a prerequisite
for the objects of the example programs. This results in compiler error
due to the non-existing output directory.
Bug-Id: 636
Signed-off-by: Janne Grunau <janne-libav@jannau.net>
11 years ago
Stefano Sabatini
5fc4dea39c
examples: add avio_reading.c example
11 years ago
Stefano Sabatini
5e2b8e4934
examples: add remuxing example
...
Show how to perform streamcopy from one container to another.
11 years ago
Michael Niedermayer
0f378d8632
doc/doxy: remove unused files
...
Reviewed-by: Stefano Sabatini <stefasab@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
11 years ago
Anton Khirnov
58f0d164de
Makefile: add html template files to the doxygen deps
11 years ago
Stefano Sabatini
5b073da7a1
doc: add script to compute texi files dependencies
...
Replace the inline awk script with a Perl script which tracks the
dependencies recursively.
This allows to correctly track dependencies for files including files
with a second level include (for example: ffmpeg-devices.texi ->
devices.texi -> outdevs.texi).
This also adds a dependency on perl for computing the dependencies, which
should not be a problem since perl is already required all the way for
building documentation.
This is a variant of commit 628ceac652
which was reverted due to out-of-tree build failure.
11 years ago
Clément Bœsch
01c9d8094a
doc/Makefile: cosmetics after previous commits.
11 years ago
Clément Bœsch
1d751768f3
build: also clean the examples with debug symbols
11 years ago
Clément Bœsch
fe318e143b
build: split examples cleaning out of docclean.
11 years ago
Clément Bœsch
1a88e84fd5
build: integrate remaining examples.
11 years ago
Andreas Unterweger
10421bcf0a
Add an audio transcoding example.
...
Signed-off-by: Anton Khirnov <anton@khirnov.net>
11 years ago
Michael Niedermayer
5b326f398e
doc/Makefile: fix building examples if a program suffix is set
...
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
11 years ago
Diego Biurrun
92f0abb27f
build: Check for pod2man instead of perl for manual page generation
...
Some systems provide Perl without pod2man.
11 years ago
Michael Niedermayer
f1db007e00
doc/Makefile fix PROGS
...
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
11 years ago
Diego Biurrun
ab81f24ad4
build: Integrate multilibrary examples into the build system
...
This includes moving libavformat/output-example to doc/examples/output.
11 years ago
Diego Biurrun
14abeaa43d
build: Separate building programs linking against libav* from building av*
...
This will allow cleaner integration of building example programs.
11 years ago
Martin Storsjö
09cd0a3176
doc: Add the host executable suffix for the print_options dependency
...
This fixes building on windows.
Signed-off-by: Martin Storsjö <martin@martin.st>
11 years ago
James Almer
eff2edae56
Partially revert "Merge commit 'f187557ab4612776f7f527ecf3d40062975c3e4c'"
...
This partially reverts commit c0237d19a0
Some scripts make use of --disable-doc
Signed-off-by: James Almer <jamrial@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
11 years ago
Diego Biurrun
f187557ab4
build: more fine-grained dependencies for documentation build tools
...
Perl is needed to build the manual pages, texi2html for the HTML pages.
11 years ago
Stefano Sabatini
af1c538850
doc/Makefile: fix man pages uninstall path
...
Fix trac ticket #3054 .
11 years ago
James Almer
e3d34100e7
doc: add *install-doc that covers all documentation
...
Signed-off-by: James Almer <jamrial@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
11 years ago
James Almer
1e97ae4ba3
doc: rename *install-doc to *install-html
...
Signed-off-by: James Almer <jamrial@gmail.com>
Reviewed-by: Stefano Sabatini <stefasab@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
11 years ago
James Almer
2df184f3d5
doc: fix install-doc dependencies
...
Put it inside its own ifdef conditional.
Signed-off-by: James Almer <jamrial@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
11 years ago
Michael Niedermayer
91acb23a28
doc: fix insane hard texi2html dependancy
...
Found-by: nevcairiel
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
11 years ago
Vittorio Giovara
f4ca970dba
configure: Add docdir configuration option
...
Signed-off-by: Luca Barbato <lu_zero@gentoo.org>
11 years ago
Michael Niedermayer
ffed7227c3
Revert "doc: add script to compute texi files dependencies"
...
This reverts commit 628ceac652
.
The commit broke out of tree builds
12 years ago
Stefano Sabatini
628ceac652
doc: add script to compute texi files dependencies
...
Replace the inline awk script with a Perl script which tracks the
dependencies recursively.
This allows to correctly track dependencies for files including files
with a second level include (for example: ffmpeg-devices.texi ->
devices.texi -> outdevs.texi).
This also adds a dependency on perl for computing the dependencies, which
should not be a problem since perl is already required all the way for
building documentation.
12 years ago
Stefano Sabatini
be3f4c13b6
doc/Makefile: install .3 man pages to man3 subdir
...
Fix trac ticket #2585 .
12 years ago
Stefano Sabatini
90cb081f88
build: drop unused ALLMANPAGES variable
12 years ago
Stefano Sabatini
9b4d9d8795
doc: enable compilation of -all tool pages
...
In particular, add documentation configuration system, through the
doc/config.texi file.
Fix trac issue #2374 .
12 years ago
Luca Barbato
7a95afe433
doc: fix dependencies in pod generation
...
The script can and will change.
12 years ago
James Almer
4f8b73129b
doc/Makefile: Fix make docclean
...
Signed-off-by: James Almer <jamrial@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
12 years ago
Clément Bœsch
00ebac6dfd
doc: stop generating syntax.html.
...
Just like doc/eval.texi, this file is meant to be included from
ffmpeg-utils.texi, and not to be used as a standalone documentation.
12 years ago
Stefano Sabatini
9bba683578
doc/Makefile: add docclean rule
...
This allows to clean the doc directory from the parent project dir.
The command:
make -C doc clean
does not work as long as the paths specified in doc/Makefile are relative
to the parent dir.
Also it is consitent with "testclean" and "distclean" targets.
12 years ago
Stefano Sabatini
cf56c20761
doc/Makefile: rework component configuration logic
...
Only enable component manual when the corresponding library providing
the feature is enabled.
12 years ago
Stefano Sabatini
5ddc072d0d
doc: add ffmpeg-bitstream-filters.texi file
12 years ago
Stefano Sabatini
3a227f5d90
doc: add ffmpeg-protocols.texi manual
12 years ago
Stefano Sabatini
9c492271a8
doc: move syntax and eval chapters from libavutil to ffmpeg-utils
...
Move utilities description to a dedicated manual, consistent with what I
did with the rest of the documentation.
12 years ago
Stefano Sabatini
d82331721e
doc: add libavdevice.texi and ffmpeg-devices.texi files
12 years ago