ffmpeg/doc/build_system.txt

FFmpeg currently uses a custom build system, this text attempts to document
some of its obscure features and options.

Makefile variables:

V
    Disable the default terse mode, the full command issued by make and its
    output will be shown on the screen.

DBG
    Preprocess x86 external assembler files to a .dbg.asm file in the object
    directory, which then gets compiled. Helps in developing those assembler
    files.

DESTDIR
    Destination directory for the install targets, useful to prepare packages
    or install FFmpeg in cross-environments.

GEN
    Set to ‘1’ to generate the missing or mismatched references.

Makefile targets:

all
    Default target, builds all the libraries and the executables.

fate
    Run the fate test suite, note that you must have installed it.

fate-list
    List all fate/regression test targets.

install
    Install headers, libraries and programs.

examples
    Build all examples located in doc/examples.

checkheaders
    Check headers dependencies.

alltools
    Build all tools in tools directory.

config
    Reconfigure the project with the current configuration.

tools/target_dec_<decoder>_fuzzer
    Build fuzzer to fuzz the specified decoder.

tools/target_bsf_<filter>_fuzzer
    Build fuzzer to fuzz the specified bitstream filter.

Useful standard make commands:
make -t <target>
    Touch all files that otherwise would be built, this is useful to reduce
    unneeded rebuilding when changing headers, but note that you must force rebuilds
    of files that actually need it by hand then.

make -j<num>
    Rebuild with multiple jobs at the same time. Faster on multi processor systems.

make -k
    Continue build in case of errors, this is useful for the regression tests
    sometimes but note that it will still not run all reg tests.
-												Revert "replace FFmpeg with Libav in doc/"

This reverts commit f8a45fa1b1764b34d4263eacd93411e8ba0484a4.

Conflicts:

	doc/optimization.txt

											
										
										
											2011-03-17 15:55:58 +00:00
+								FFmpeg currently uses a custom build system, this text attempts to document
-												custom build system documentation

Originally committed as revision 25375 to svn://svn.ffmpeg.org/ffmpeg/trunk

											
										
										
											2010-10-06 17:53:02 +00:00
+								some of its obscure features and options.
-												doc: update build system documentation

Split normal build system documentation and the fate one.

Document THREADS make variable and provide an introduction to fate.
Document DESTDIR make variable and add some generic targets.

											
										
										
											2011-03-21 23:20:56 +00:00
+								Makefile variables:
-												custom build system documentation

Originally committed as revision 25375 to svn://svn.ffmpeg.org/ffmpeg/trunk

											
										
										
											2010-10-06 17:53:02 +00:00
-												doc: update build system documentation

Split normal build system documentation and the fate one.

Document THREADS make variable and provide an introduction to fate.
Document DESTDIR make variable and add some generic targets.

											
										
										
											2011-03-21 23:20:56 +00:00
+								V
 								    Disable the default terse mode, the full command issued by make and its
 								    output will be shown on the screen.
-												custom build system documentation

Originally committed as revision 25375 to svn://svn.ffmpeg.org/ffmpeg/trunk

											
										
										
											2010-10-06 17:53:02 +00:00
-												x86/doc/Makefile: DBG=1 to preprocess external asm

The macro hell sometimes make it difficult to trace the source of
an error, so it is easier to analyze the preprocessed output.

This patch makes this automatical by specifying DBG=1 on the
command line: a file ffmpeg/dir/file.asm gets preprocessed to
builddir/dir/file.dbg.asm, which is then compiled.

Signed-off-by: Michael Niedermayer <michaelni@gmx.at>

											
										
										
											2015-02-08 11:18:27 +00:00
+								DBG
 								    Preprocess x86 external assembler files to a .dbg.asm file in the object
-												doc/build_system: miscellaneous typo and consistency fixes

Signed-off-by: Ganesh Ajjanagadde <gajjanagadde@gmail.com>

											
										
										
											2015-10-08 13:01:04 +00:00
+								    directory, which then gets compiled. Helps in developing those assembler
-												x86/doc/Makefile: DBG=1 to preprocess external asm

The macro hell sometimes make it difficult to trace the source of
an error, so it is easier to analyze the preprocessed output.

This patch makes this automatical by specifying DBG=1 on the
command line: a file ffmpeg/dir/file.asm gets preprocessed to
builddir/dir/file.dbg.asm, which is then compiled.

Signed-off-by: Michael Niedermayer <michaelni@gmx.at>

											
										
										
											2015-02-08 11:18:27 +00:00
+								    files.
-												doc: update build system documentation

Split normal build system documentation and the fate one.

Document THREADS make variable and provide an introduction to fate.
Document DESTDIR make variable and add some generic targets.

											
										
										
											2011-03-21 23:20:56 +00:00
+								DESTDIR
 								    Destination directory for the install targets, useful to prepare packages
-												Revert some silly renamings that leaked in from a pull.

											
										
										
											2011-03-28 19:57:00 +00:00
+								    or install FFmpeg in cross-environments.
-												custom build system documentation

Originally committed as revision 25375 to svn://svn.ffmpeg.org/ffmpeg/trunk

											
										
										
											2010-10-06 17:53:02 +00:00
-												doc/build_system: Document GEN, text taken from the webpage

Signed-off-by: Michael Niedermayer <michaelni@gmx.at>

											
										
										
											2015-05-27 10:23:01 +00:00
+								GEN
 								    Set to ‘1’ to generate the missing or mismatched references.
-												doc: update build system documentation

Split normal build system documentation and the fate one.

Document THREADS make variable and provide an introduction to fate.
Document DESTDIR make variable and add some generic targets.

											
										
										
											2011-03-21 23:20:56 +00:00
+								Makefile targets:
-												custom build system documentation

Originally committed as revision 25375 to svn://svn.ffmpeg.org/ffmpeg/trunk

											
										
										
											2010-10-06 17:53:02 +00:00
-												doc: update build system documentation

Split normal build system documentation and the fate one.

Document THREADS make variable and provide an introduction to fate.
Document DESTDIR make variable and add some generic targets.

											
										
										
											2011-03-21 23:20:56 +00:00
+								all
 								    Default target, builds all the libraries and the executables.
-												custom build system documentation

Originally committed as revision 25375 to svn://svn.ffmpeg.org/ffmpeg/trunk

											
										
										
											2010-10-06 17:53:02 +00:00
-												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>

											
										
										
											2011-03-26 01:42:40 +00:00
+								fate
-												doc/build_system: miscellaneous typo and consistency fixes

Signed-off-by: Ganesh Ajjanagadde <gajjanagadde@gmail.com>

											
										
										
											2015-10-08 13:01:04 +00:00
+								    Run the fate test suite, note that you must have installed it.
-												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>

											
										
										
											2011-03-26 01:42:40 +00:00
 								fate-list
-												doc/build_system: miscellaneous typo and consistency fixes

Signed-off-by: Ganesh Ajjanagadde <gajjanagadde@gmail.com>

											
										
										
											2015-10-08 13:01:04 +00:00
+								    List all fate/regression test targets.
-												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>

											
										
										
											2011-03-26 01:42:40 +00:00
-												doc: update build system documentation

Split normal build system documentation and the fate one.

Document THREADS make variable and provide an introduction to fate.
Document DESTDIR make variable and add some generic targets.

											
										
										
											2011-03-21 23:20:56 +00:00
+								install
 								    Install headers, libraries and programs.
-												custom build system documentation

Originally committed as revision 25375 to svn://svn.ffmpeg.org/ffmpeg/trunk

											
										
										
											2010-10-06 17:53:02 +00:00
-												doc/build_system: document examples and config targets

Signed-off-by: Lukasz Marek <lukasz.m.luki2@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>

											
										
										
											2014-06-24 22:40:09 +00:00
+								examples
 								    Build all examples located in doc/examples.
-												doc/build_system: Document checkheaders/alltools and consistency fixes

Document checkheaders/alltools and consistency fixes

Signed-off-by: Jun Zhao <barryjzhao@tencent.com>

											
										
										
											2019-05-22 04:46:05 +00:00
+								checkheaders
 								    Check headers dependencies.
-												custom build system documentation

Originally committed as revision 25375 to svn://svn.ffmpeg.org/ffmpeg/trunk

											
										
										
											2010-10-06 17:53:02 +00:00
-												doc/build_system: Document checkheaders/alltools and consistency fixes

Document checkheaders/alltools and consistency fixes

Signed-off-by: Jun Zhao <barryjzhao@tencent.com>

											
										
										
											2019-05-22 04:46:05 +00:00
+								alltools
 								    Build all tools in tools directory.
-												custom build system documentation

Originally committed as revision 25375 to svn://svn.ffmpeg.org/ffmpeg/trunk

											
										
										
											2010-10-06 17:53:02 +00:00
-												doc/build_system: document examples and config targets

Signed-off-by: Lukasz Marek <lukasz.m.luki2@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>

											
										
										
											2014-06-24 22:40:09 +00:00
+								config
-												doc/build_system: miscellaneous typo and consistency fixes

Signed-off-by: Ganesh Ajjanagadde <gajjanagadde@gmail.com>

											
										
										
											2015-10-08 13:01:04 +00:00
+								    Reconfigure the project with the current configuration.
-												doc/build_system: document examples and config targets

Signed-off-by: Lukasz Marek <lukasz.m.luki2@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>

											
										
										
											2014-06-24 22:40:09 +00:00
-												doc/build_system: Document how to build decoder fuzzer

Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>

											
										
										
											2017-05-06 00:02:08 +00:00
+								tools/target_dec_<decoder>_fuzzer
 								    Build fuzzer to fuzz the specified decoder.
-												tools: add a fuzzer tool for bitstream filters

Reviewed-by: Michael Niedermayer <michael@niedermayer.cc>
Signed-off-by: James Almer <jamrial@gmail.com>

											
										
										
											2019-11-30 18:57:44 +00:00
+								tools/target_bsf_<filter>_fuzzer
 								    Build fuzzer to fuzz the specified bitstream filter.
-												custom build system documentation

Originally committed as revision 25375 to svn://svn.ffmpeg.org/ffmpeg/trunk

											
										
										
											2010-10-06 17:53:02 +00:00
 								Useful standard make commands:
 								make -t <target>
-												doc/build_system: miscellaneous typo and consistency fixes

Signed-off-by: Ganesh Ajjanagadde <gajjanagadde@gmail.com>

											
										
										
											2015-10-08 13:01:04 +00:00
+								    Touch all files that otherwise would be built, this is useful to reduce
 								    unneeded rebuilding when changing headers, but note that you must force rebuilds
-												custom build system documentation

Originally committed as revision 25375 to svn://svn.ffmpeg.org/ffmpeg/trunk

											
										
										
											2010-10-06 17:53:02 +00:00
+								    of files that actually need it by hand then.
 								make -j<num>
-												doc/build_system: miscellaneous typo and consistency fixes

Signed-off-by: Ganesh Ajjanagadde <gajjanagadde@gmail.com>

											
										
										
											2015-10-08 13:01:04 +00:00
+								    Rebuild with multiple jobs at the same time. Faster on multi processor systems.
-												custom build system documentation

Originally committed as revision 25375 to svn://svn.ffmpeg.org/ffmpeg/trunk

											
										
										
											2010-10-06 17:53:02 +00:00
 								make -k
-												doc/build_system: miscellaneous typo and consistency fixes

Signed-off-by: Ganesh Ajjanagadde <gajjanagadde@gmail.com>

											
										
										
											2015-10-08 13:01:04 +00:00
+								    Continue build in case of errors, this is useful for the regression tests
 								    sometimes but note that it will still not run all reg tests.
-												custom build system documentation

Originally committed as revision 25375 to svn://svn.ffmpeg.org/ffmpeg/trunk

											
										
										
											2010-10-06 17:53:02 +00:00