Commit Graph

143 Commits

Author SHA1 Message Date
Janne Grunau b3fab1f2cd doc: add apidoc target for doxygen API documentation
Documentation includes only the externally visible API of the installed
headers.

Based on a patch by Anton Khirnov <anton@khirnov.net>.

Signed-off-by: Anton Khirnov <anton@khirnov.net>
2012-11-02 18:28:56 +01:00
Michael Niedermayer 52dc18d414 Merge remote-tracking branch 'qatar/master'
* qatar/master:
  x86: vc1: call ff_vc1dsp_init_x86() under if (ARCH_X86)
  x86: cavs: call ff_cavsdsp_init_x86() under if (ARCH_X86)
  x86: call most of the x86 dsp init functions under if (ARCH_X86)
  doc: support the new website layout
  doc: remove a warning from filters.texi
  doc: initial nut documentation
  segment: drop global headers setting
  lavu: fix typo in Makefile

Conflicts:
	doc/Makefile
	doc/filters.texi
	doc/t2h.init
	libavcodec/fmtconvert.c
	libavcodec/proresdsp.c
	libavcodec/x86/Makefile
	libavcodec/x86/vc1dsp_mmx.c

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2012-10-08 21:46:34 +02:00
Luca Barbato 175d0d94da doc: initial nut documentation 2012-10-08 11:22:42 +02:00
Stefano Sabatini 8e2cf68d09 doc/Makefile: add doc target, as an alias for "documentation"
Consistent with --enable-doc, and easier to type.
2012-08-18 10:04:25 +02:00
Stefano Sabatini c3da2c19e4 build: extend documentation building mechanism
Allow to select specific documentation components, and reliably check for
component dependencies.

In particular, check for perl presence on the system.
2012-08-13 12:22:02 +02:00
Stefano Sabatini e874b29296 doc/Makefile: invoke perl to interpret texi2pod.pl
Do not rely on shebang directive in the script, whose exact behavior is
system dependent.
2012-08-10 23:14:57 +02:00
Michael Niedermayer c6963a220d Merge remote-tracking branch 'qatar/master'
* qatar/master:
  proresdsp: port x86 assembly to cpuflags.
  lavr: x86: improve non-SSE4 version of S16_TO_S32_SX macro
  lavfi: better channel layout negotiation
  alac: check for truncated packets
  alac: reverse lpc coeff order, simplify filter
  lavr: add x86-optimized mixing functions
  x86: add support for fmaddps fma4 instruction with abstraction to avx/sse
  tscc2: fix typo in array index
  build: use COMPILE template for HOSTOBJS
  build: do full flag handling for all compiler-type tools
  eval: fix printing of NaN in eval fate test.
  build: Rename aandct component to more descriptive aandcttables
  mpegaudio: bury inline asm under HAVE_INLINE_ASM.
  x86inc: automatically insert vzeroupper for YMM functions.
  rtmp: Check the buffer length of ping packets
  rtmp: Allow having more unknown data at the end of a chunk size packet without failing
  rtmp: Prevent reading outside of an allocate buffer when receiving server bandwidth packets

Conflicts:
	Makefile
	configure
	libavcodec/x86/proresdsp.asm
	libavutil/eval.c

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2012-07-27 23:42:19 +02:00
Mans Rullgard b9d3c37848 build: use COMPILE template for HOSTOBJS
Signed-off-by: Mans Rullgard <mans@mansr.com>
2012-07-26 23:58:59 +01:00
jamal d48f014ff1 doc/Makefile: Add missing $(HOSTEXESUF) to print_options 2012-07-14 11:47:09 +02:00
jamal 3e03f8d8b2 build: Fix documentation dependencies and rules 2012-07-14 11:47:01 +02:00
Stefano Sabatini 5a6c7a218c doc: merge libavfilter.texi into filters.texi
There is no much point into splitting documentation for filters. Also
having a separate document for a library is inconsistent.
2012-07-14 11:38:53 +02:00
Stefano Sabatini 27127ebe6c doc: add syntax.texi file 2012-05-22 00:39:53 +02:00
Michael Niedermayer d40ff29cac Merge remote-tracking branch 'qatar/master'
* qatar/master:
  asf: only set index_read if the index contained entries.
  cabac: add overread protection to BRANCHLESS_GET_CABAC().
  cabac: increment jump locations by one in callers of BRANCHLESS_GET_CABAC().
  cabac: remove unused argument from BRANCHLESS_GET_CABAC_UPDATE().
  cabac: use struct+offset instead of memory operand in BRANCHLESS_GET_CABAC().
  h264: add overread protection to get_cabac_bypass_sign_x86().
  h264: reindent get_cabac_bypass_sign_x86().
  h264: use struct offsets in get_cabac_bypass_sign_x86().
  h264: fix overreads in cabac reader.
  wmall: fix seeking.
  lagarith: fix buffer overreads.
  dvdec: drop unnecessary dv_tablegen.h #include
  build: fix doc generation errors in parallel builds
  Replace memset(0) by zero initializations.
  faandct: Remove FAAN_POSTSCALE define and related code.
  dvenc: print allowed profiles if the video doesn't conform to any of them.
  avcodec_encode_{audio,video}: only reallocate output packet when it has non-zero size.
  FATE: add a test for vp8 with changing frame size.
  fate: add kgv1 fate test.
  oggdec: calculate correct timestamps in Ogg/FLAC

Conflicts:
	libavcodec/4xm.c
	libavcodec/cook.c
	libavcodec/dvdata.c
	libavcodec/dvdsubdec.c
	libavcodec/lagarith.c
	libavcodec/lagarithrac.c
	libavcodec/utils.c
	tests/fate/video.mak

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2012-03-29 04:11:10 +02:00
Mans Rullgard 2efb710a34 build: fix doc generation errors in parallel builds
The $(dir) function used to construct OBJDIRS includes a trailing slash
in the names returned, which GNU make 3.82 does not match to the
slash-less 'doc' in the documentation dependencies, causing parallel
build to fail.  Adding a slash fixes this and still works with make
3.81.

Signed-off-by: Mans Rullgard <mans@mansr.com>
2012-03-28 11:42:19 +01:00
Michael Niedermayer 7b453d1c60 Merge remote-tracking branch 'qatar/master'
* qatar/master:
  westwood_vqa: fix SND0 chunk handling
  westwood_vqa: set video stream duration
  raw: forward avpicture_fill() error code in raw_decode().
  build: Do not explicitly add the doc directory to the OBJDIRS list.
  dv: Split off DV video decoder into its own file.
  build: fix RALF decoder standalone compilation, which depends on Golomb code
  configure: Drop stray duplicate entry for --disable-fft from help output.

Conflicts:
	libavcodec/dv.c
	libavcodec/rawdec.c
	libavformat/westwood_vqa.c

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2012-03-28 04:12:24 +02:00
Diego Biurrun 8e0b7e2f14 build: Do not explicitly add the doc directory to the OBJDIRS list.
Now that a documentation generator is built in the doc directory,
this is no longer necessary.  Fixes the Make warning:
Makefile:188: target `doc' given more than once in the same rule.
2012-03-27 11:15:47 +02:00
Michael Niedermayer 0ebd83617f Merge remote-tracking branch 'qatar/master'
* qatar/master: (27 commits)
  avconv: free packet in write_frame() when discarding due to frame number limit
  FATE: use +/- flag option syntax for vp8 emu-edge tests
  lavf: make av_interleave_packet_per_dts() private.
  lavf: deprecate av_read_packet().
  oggdec: output correct timestamps for Vorbis
  avconv: pass input stream timestamps to audio encoders
  lavc: shrink encoded audio packet size after encoding.
  xa: set correct bit rate
  xa: do not set bit_rate, block_align, or bits_per_coded_sample
  xa: fix end-of-file handling
  xa: fix timestamp calculation
  bink: fix typo in FFALIGN() argument
  bink: align plane width to 8 when calculating bundle sizes
  doc: pass -Idoc texi2html and texi2pod
  doc: texi2pod: add -I flag
  movenc: Add a min_frag_duration option
  rtsp: Set the default delay to 0.1 s for the RTSP/SDP/RTP demuxers
  libavformat: Set the default for the max_delay option to -1
  Generate manpages for AV{Format,Codec}Context AVOptions.
  doc/avconv: remove entries for AVOptions.
  ...

Conflicts:
	doc/Makefile
	doc/ffmpeg.texi
	doc/muxers.texi
	ffmpeg.c
	libavcodec/Makefile
	libavcodec/options.c
	libavcodec/vp8.c
	libavformat/options.c
	tests/fate/demux.mak
	tests/ref/fate/truemotion1-15
	tests/ref/fate/truemotion1-24

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2012-03-21 01:33:53 +01:00
Mans Rullgard 2ac3df858c doc: pass -Idoc texi2html and texi2pod
This fixes doc generation in build tree separate from source.

Signed-off-by: Mans Rullgard <mans@mansr.com>
2012-03-20 11:10:25 +00:00
Anton Khirnov 0d0b81f941 Generate manpages for AV{Format,Codec}Context AVOptions. 2012-03-20 07:10:06 +01:00
Alexander Strasser c7062802d9 doc: build: TEXIDEP: Recognize verbatim includes
When generating the .dep files for .texi sources, verbatim includes
(@verbatiminclude) should also be taken into account.

Signed-off-by: Alexander Strasser <eclipse7@gmx.net>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2011-12-24 02:56:52 +01:00
Michael Niedermayer c2c284b3eb Revert "doc: build: TEXIDEP: Recognize verbatim includes"
This reverts commit e5cbf24e45.

This commits breaks out of tree builds
2011-12-23 18:01:10 +01:00
Alexander Strasser abab44086f doc: fate: Support building a plain text version
Also create a plain text (.txt) file from fate.texi if the makeinfo
program is available.

Signed-off-by: Alexander Strasser <eclipse7@gmx.net>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2011-12-20 16:05:01 +01:00
Alexander Strasser e5cbf24e45 doc: build: TEXIDEP: Recognize verbatim includes
When generating the .dep files for .texi sources, verbatim includes
(@verbatiminclude) should also be taken into account.

Signed-off-by: Alexander Strasser <eclipse7@gmx.net>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2011-12-20 16:05:01 +01:00
Luca Barbato 1de6e14efe doc: split platform specific information
Move the platform-specific information in its own file.
2011-12-09 18:26:31 +01:00
Luca Barbato 2f017d9791 doc: port the git-howto to texinfo 2011-12-09 18:26:31 +01:00
Luca Barbato 1ebbdda1d2 doc: document fate in a texinfo
Summarize the information provided in the wiki and the one provided
in fate.txt
2011-12-09 18:26:17 +01:00
Diego Biurrun 47b20a1db0 build: merge lists of HTML documentation targets 2011-12-08 01:01:00 +01:00
Mans Rullgard 5e27ec28f0 build: create output directories as needed
Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-29 09:14:56 +01:00
Mans Rullgard 7ac6910dd8 build: call texi2pod.pl with full path instead of symlink
Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-28 18:15:19 +01:00
Mans Rullgard f038cf3c74 build: remove SRC_PATH_BARE variable
Setting SRC_PATH to "." when building in-tree removes the need
for a quoted version of the source path since out-of-tree builds
are not possible if the pathname contains spaces.

Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-23 12:17:25 +01:00
Mans Rullgard f87b03b50d build: move documentation rules to doc/Makefile
Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-22 22:59:46 +01:00
Diego Biurrun e9b19db82b Make documentation build nonrecursive: Merge it into the top-level Makefile.
Originally committed as revision 9042 to svn://svn.ffmpeg.org/ffmpeg/trunk
2007-05-17 08:39:50 +00:00
Måns Rullgård 997baf0141 allow spaces in source and build directory names
out of tree builds from a source dir with spaces is impossible
due to how make handles vpath

Originally committed as revision 6938 to svn://svn.ffmpeg.org/ffmpeg/trunk
2006-11-08 00:02:15 +00:00
Diego Biurrun 3263626feb Mark all phony targets as such.
Originally committed as revision 6538 to svn://svn.ffmpeg.org/ffmpeg/trunk
2006-10-03 17:42:17 +00:00
Diego Biurrun 041514a422 Revert last commit, VPATH is necessary for out-of-tree builds.
Originally committed as revision 6014 to svn://svn.ffmpeg.org/ffmpeg/trunk
2006-08-17 16:28:47 +00:00
Diego Biurrun cf41e66736 Remove unnecessary include and variable declaration.
Originally committed as revision 6013 to svn://svn.ffmpeg.org/ffmpeg/trunk
2006-08-17 16:02:57 +00:00
Philipp Matthias Hahn 8b8e1c5580 Out-of-directory build patch by (Philipp Matthias Hahn <pmhahn titan.lahn de>)
preserve support for spaces in directories in case of in-tree builds by (James A. Morrison <ja2morri csclub.uwaterloo ca>)

Originally committed as revision 3855 to svn://svn.ffmpeg.org/ffmpeg/trunk
2005-01-21 22:16:05 +00:00
Fabrice Bellard e99c4e1037 added ffplay documentation - added automatic man page generation for ffmpeg, ffserver and ffplay
Originally committed as revision 2136 to svn://svn.ffmpeg.org/ffmpeg/trunk
2003-08-24 11:16:29 +00:00
Fabrice Bellard c09948b6dc autogeneration of html files
Originally committed as revision 1927 to svn://svn.ffmpeg.org/ffmpeg/trunk
2003-06-02 20:13:30 +00:00
Philip Gladstone 9d6f1d52c5 Moved hook documentation into the doc directory
Originally committed as revision 1292 to svn://svn.ffmpeg.org/ffmpeg/trunk
2002-11-30 17:12:23 +00:00
Fabrice Bellard c70a211997 ffserver documentation update
Originally committed as revision 1234 to svn://svn.ffmpeg.org/ffmpeg/trunk
2002-11-19 19:47:50 +00:00
Fabrice Bellard 3b783b6b58 added faq.html
Originally committed as revision 1159 to svn://svn.ffmpeg.org/ffmpeg/trunk
2002-11-04 18:50:27 +00:00
Fabrice Bellard 9181577ccb new texinfo documentation - HTML version also included
Originally committed as revision 1085 to svn://svn.ffmpeg.org/ffmpeg/trunk
2002-10-27 22:00:34 +00:00