Commit Graph

147 Commits

Author SHA1 Message Date
Thilo Borgmann 6709e468f6 doc: Merge doc/dev_community/* and Code of Conduct into a seperate file
Remove doc/dev_communit markup files completely as they are at the wrong place.
Create a new community page, merging all of doc/dev_community and subsection Code of Conduct into a common place.
The corresponding patch to ffmpeg-web puts the Organisation & Code of Conduct into a seperate community chapter on the FFmpeg website.
2023-03-01 00:30:59 +01:00
Timo Rothenpieler b2823333d5 doc: fix css file install for out-of-tree builds 2022-04-19 13:04:42 +02:00
Timo Rothenpieler d5687236ab doc: install css files along html docs 2022-04-18 12:55:32 +02:00
Anton Khirnov 5384ee486a doc: fix generating doxy with out-of-tree builds
Broken in 753930bc73, as the path to
Doxyfile passed to doxy-wrapper.sh is relative to the build dir, while
the recipe cd's to the source dir before invoking the wrapper.
2021-06-11 19:28:27 +02:00
Lou Logan d17a00379e doc: Add mailing list FAQ
Signed-off-by: Lou Logan <lou@lrcd.com>
Reviewed-by: Kieran O Leary <kieran.o.leary@gmail.com>
Reviewed-by: Carl Eugen Hoyos <ceffmpeg@gmail.com>
2017-10-03 15:25:07 -08:00
James Almer b25d6290c6 Merge commit 'acb0dea27efff4b35796015b96570b59fd517078'
* commit 'acb0dea27efff4b35796015b96570b59fd517078':
  build: Split logic for building examples off into a separate Makefile

We already have a Makefile in doc/examples, but it's separate from the build
system and meant to be installed as part of the documentation to help users
compile the installed .c example files.
Move it to Makefile.example to make place for the new build system Makefile.

Merged-by: James Almer <jamrial@gmail.com>
2017-09-29 15:12:43 -03:00
James Almer 0351b8e358 Merge commit 'db4903eb4875bed6c5b8a4259cdd7bc1768dfdf6'
* commit 'db4903eb4875bed6c5b8a4259cdd7bc1768dfdf6':
  build: Avoid duplication in examples lists

See 1a88e84fd5

Merged-by: James Almer <jamrial@gmail.com>
2017-09-28 19:22:21 -03:00
James Almer d4b00a23c6 Merge commit '533339bdcc3b39bbd708c723b3cd0b5898350f0f'
* commit '533339bdcc3b39bbd708c723b3cd0b5898350f0f':
  build: Drop leftover reference to old EXAMPLES logic

Merged-by: James Almer <jamrial@gmail.com>
2017-09-28 19:08:37 -03:00
Jun Zhao 1e0c75ea16 examples/hw_decode: Add a HWAccel decoding example.
Works with VAAPI, VDPAU, DXVA2 and D3D11VA.

Signed-off-by: Liu, Kaixuan <kaixuan.liu@intel.com>
Signed-off-by: Jun Zhao <jun.zhao@intel.com>
Reviewed-by: Steven Liu <lingjiujianke@gmail.com>
Signed-off-by: Mark Thompson <sw@jkqxz.net>
2017-07-30 00:15:05 +01:00
Clément Bœsch 3f17751eeb Merge commit '11a9320de54759340531177c9f2b1e31e6112cc2'
* commit '11a9320de54759340531177c9f2b1e31e6112cc2':
  build: Move build-system-related helper files to a separate subdirectory

"ffbuild" directory name is used instead of "avbuild".

Merged-by: Clément Bœsch <u@pkh.me>
2017-05-03 16:49:12 +02:00
Clément Bœsch 925ce244d8 Merge commit '7b1f03477f1a43d2261fbd83e50a4ad90c7f806d'
* commit '7b1f03477f1a43d2261fbd83e50a4ad90c7f806d':
  examples/avcodec: split the remaining two examples into separate files

Merged-by: Clément Bœsch <u@pkh.me>
2017-03-29 14:09:09 +02:00
Clément Bœsch 878070cc56 Merge commit 'f5df897c4b61985e3afc89ba1290649712ff438e'
* commit 'f5df897c4b61985e3afc89ba1290649712ff438e':
  examples/avcodec: split audio decoding into a separate example

Merged-by: Clément Bœsch <u@pkh.me>
2017-03-29 13:43:47 +02:00
Clément Bœsch b785af4868 Merge commit '40aaa8dadfd1c69ff4460d04750e1403b5535a6d'
* commit '40aaa8dadfd1c69ff4460d04750e1403b5535a6d':
  examples/avcodec: split audio encoding into a separate example

Merged-by: Clément Bœsch <u@pkh.me>
2017-03-29 13:29:22 +02:00
Diego Biurrun acb0dea27e build: Split logic for building examples off into a separate Makefile 2017-02-21 16:10:51 +01:00
Diego Biurrun db4903eb48 build: Avoid duplication in examples lists 2017-02-21 16:10:51 +01:00
Diego Biurrun 533339bdcc build: Drop leftover reference to old EXAMPLES logic 2017-02-21 16:10:51 +01:00
Anton Khirnov 7b1f03477f examples/avcodec: split the remaining two examples into separate files 2016-11-02 10:16:04 +01:00
Anton Khirnov f5df897c4b examples/avcodec: split audio decoding into a separate example
The four examples (audio/video encoding/decoding) are completely
independent so it makes little sense to have them all in one file.
2016-11-02 10:13:27 +01:00
Anton Khirnov 40aaa8dadf examples/avcodec: split audio encoding into a separate example
The four examples (audio/video encoding/decoding) are completely
independent so it makes little sense to have them all in one file.
2016-11-02 10:11:46 +01:00
Clément Bœsch 1a9b4bc4c7 doc/examples: build http_multiclient example 2016-09-30 19:35:52 +02:00
Clément Bœsch 3d064b7802 build: remove references to inexistant avcodec example 2016-09-30 19:35:52 +02:00
Diego Biurrun 8c201dde0a build: doc: more fine-grained dependencies for generated texi files 2016-09-15 21:37:16 +02:00
Timothy Gu fbe22355b7 build: Make API documentation depend on config.mak
The Doxygen command is generated from the list of installed headers,
which may change per configuration (e.g. `--enable-gpl` results in
libpostproc to be built and installed).
2016-08-02 07:45:13 -07:00
Andreas Cadhalpun 753930bc73 doc: make apidoc output independent of SRC_PATH
Previously it included the SRC_PATH in every title.

Reviewed-by: Michael Niedermayer <michael@niedermayer.cc>
Signed-off-by: Andreas Cadhalpun <Andreas.Cadhalpun@googlemail.com>
2016-01-02 12:11:36 +01:00
Mariusz Szczepańczyk 767d780ec0 doc/examples: rename avio_list_dir -> avio_dir_cmd
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
2015-08-16 02:16:47 +02:00
Lukasz Marek 56b7aa2138 doc/examples: add directory listing example
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2015-03-28 03:13:44 +01:00
Michael Niedermayer e73b3dba3e Merge commit '990e4a6639d0714198583c2812b1074b5751898f'
* commit '990e4a6639d0714198583c2812b1074b5751898f':
  Add a QSV decoding example.

Conflicts:
	configure
	doc/Makefile

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2015-03-01 00:30:20 +01:00
Anton Khirnov 990e4a6639 Add a QSV decoding example. 2015-02-28 21:51:24 +01:00
Andreas Cadhalpun 103e4c5863 stop embedding the build date
Theis makes the build binary reproducible.

Signed-off-by: Andreas Cadhalpun <Andreas.Cadhalpun@googlemail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2015-02-02 05:04:14 +01:00
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>
2014-09-04 02:34:20 +02:00
Rong Yan 6abeaf2781 build sys: enable the decoding_encoding example under the ffmpeg/doc/examples
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2014-09-02 04:19:15 +02:00
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.
2014-08-18 14:13:57 +02:00
Timothy Gu 8e6a66b662 doc: add doxygen target tag
Signed-off-by: Timothy Gu <timothygu99@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2014-07-08 02:11:19 +02:00
Timothy Gu cee98aadb1 doc: make doxygen program configurable
Signed-off-by: Timothy Gu <timothygu99@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2014-07-08 02:08:04 +02:00
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>
2014-07-08 02:03:35 +02:00
Andrey Utkin e10ab43614 doc/examples: Add example transcoding.c
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2014-03-17 20:56:33 +01:00
Michael Niedermayer 1f2bacc897 Merge commit 'e7dfaf16a403972eb6aed5ce8f84c0085bd2fb5a'
* commit 'e7dfaf16a403972eb6aed5ce8f84c0085bd2fb5a':
  libavfilter: example audio filtering program

Conflicts:
	.gitignore
	configure
	doc/Makefile

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2014-02-25 20:26:00 +01:00
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>
2014-02-25 13:22:10 +01:00
Michael Niedermayer 1fc74926a5 Merge commit 'b339182eba34f28de5f1a477cdd2c84f1ef35d90'
* commit 'b339182eba34f28de5f1a477cdd2c84f1ef35d90':
  Move all example programs to doc/examples

Conflicts:
	configure
	doc/Makefile
	doc/doxy-wrapper.sh
	doc/examples/avcodec.c
	doc/examples/decoding_encoding.c
	doc/examples/metadata.c
	doc/examples/muxing.c
	doc/examples/transcode_aac.c
	libavcodec/Makefile
	libavcodec/api-example.c
	libavformat/Makefile

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2014-02-17 02:22:01 +01:00
Diego Biurrun b339182eba Move all example programs to doc/examples
Also drop support for building examples in library directories.
2014-02-16 21:37:21 +01:00
Michael Niedermayer 71052d85c1 Merge commit '3a26ccbf0d9f806d067e76a3f484170abecb36b3'
* commit '3a26ccbf0d9f806d067e76a3f484170abecb36b3':
  build: doxy: Include code examples in Doxygen documentation

Conflicts:
	doc/Makefile

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2014-02-14 15:23:29 +01:00
Michael Niedermayer 2fd0b5bd60 Merge commit 'f1f42cfc66804907d1df9231469e4296472bb0f5'
* commit 'f1f42cfc66804907d1df9231469e4296472bb0f5':
  build: Do not pass HTML snippets and stylesheet as input to Doxygen

Conflicts:
	doc/Makefile

See: 0f378d8632
Merged-by: Michael Niedermayer <michaelni@gmx.at>
2014-02-14 14:53:54 +01:00
Diego Biurrun 3a26ccbf0d build: doxy: Include code examples in Doxygen documentation 2014-02-14 12:01:35 +01:00
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.
2014-02-14 12:01:35 +01:00
Michael Niedermayer 1c1bb203dd Merge remote-tracking branch 'qatar/master'
* qatar/master:
  build: fix examples compilation when EXESUF is not empty

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2014-02-10 14:24:15 +01:00
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>
2014-02-10 13:23:21 +01:00
Stefano Sabatini 5fc4dea39c examples: add avio_reading.c example 2014-02-02 11:58:23 +01:00
Stefano Sabatini 5e2b8e4934 examples: add remuxing example
Show how to perform streamcopy from one container to another.
2014-01-20 13:10:10 +01:00
Michael Niedermayer 0f378d8632 doc/doxy: remove unused files
Reviewed-by: Stefano Sabatini <stefasab@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2014-01-02 02:17:59 +01:00
Michael Niedermayer 9c29967ae6 Merge remote-tracking branch 'qatar/master'
* qatar/master:
  Makefile: add html template files to the doxygen deps

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2014-01-02 02:02:21 +01:00