diff options
| author | Stefano Sabatini <stefasab@gmail.com> | 2013-07-05 10:22:03 +0200 |
|---|---|---|
| committer | Stefano Sabatini <stefasab@gmail.com> | 2013-07-11 00:01:19 +0200 |
| commit | e7a6962e7650e3c105b8658788c7a3ee9f5f1f2b (patch) | |
| tree | 1ef8c4f2cb2db1a3f5c9b5735f7e60e4cc8e0a7e /doc/developer.texi | |
| parent | db4e191d8897162b9dfc5c0eab49a2d443f01a55 (diff) | |
| download | ffmpeg-e7a6962e7650e3c105b8658788c7a3ee9f5f1f2b.tar.gz | |
doc/developer: update sections about external development
Replace the sections "API" and "Integrating libavcodec or libavformat"
with updated / more accurate text.
See thread:
Subject: [FFmpeg-devel] [PATCH] doc/developer: merge and update sections about external development
Date: Fri, 5 Jul 2013 11:07:07 +0200
Diffstat (limited to 'doc/developer.texi')
| -rw-r--r-- | doc/developer.texi | 40 |
1 files changed, 17 insertions, 23 deletions
diff --git a/doc/developer.texi b/doc/developer.texi index 5972d87bfa..af7e7de551 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -11,29 +11,23 @@ @chapter Developers Guide -@section API -@itemize @bullet -@item libavcodec is the library containing the codecs (both encoding and -decoding). Look at @file{doc/examples/decoding_encoding.c} to see how to use -it. - -@item libavformat is the library containing the file format handling (mux and -demux code for several formats). Look at @file{ffplay.c} to use it in a -player. See @file{doc/examples/muxing.c} to use it to generate audio or video -streams. - -@end itemize - -@section Integrating libavcodec or libavformat in your program - -You can integrate all the source code of the libraries to link them -statically to avoid any version problem. All you need is to provide a -'config.mak' and a 'config.h' in the parent directory. See the defines -generated by ./configure to understand what is needed. - -You can use libavcodec or libavformat in your commercial program, but -@emph{any patch you make must be published}. The best way to proceed is -to send your patches to the FFmpeg mailing list. +@section Notes for external developers + +This document is mostly useful for internal FFmpeg developers. +External developers who need to use the API in their application should +refer to the API doxygen documentation in the public headers, and +check the examples in @file{doc/examples} and in the source code to +see how the public API is employed. + +You can use the FFmpeg libraries in your commercial program, but you +are encouraged to @emph{publish any patch you make}. In this case the +best way to proceed is to send your patches to the ffmpeg-devel +mailing list following the guidelines illustrated in the remainder of +this document. + +For more detailed legal information about the use of FFmpeg in +external programs read the @file{LICENSE} file in the source tree and +consult @url{http://ffmpeg.org/legal.html}. @section Contributing |