Commit e7a6962e authored by Stefano Sabatini's avatar Stefano Sabatini

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
parent db4e191d
...@@ -11,29 +11,23 @@ ...@@ -11,29 +11,23 @@
@chapter Developers Guide @chapter Developers Guide
@section API @section Notes for external developers
@itemize @bullet
@item libavcodec is the library containing the codecs (both encoding and This document is mostly useful for internal FFmpeg developers.
decoding). Look at @file{doc/examples/decoding_encoding.c} to see how to use External developers who need to use the API in their application should
it. refer to the API doxygen documentation in the public headers, and
check the examples in @file{doc/examples} and in the source code to
@item libavformat is the library containing the file format handling (mux and see how the public API is employed.
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 You can use the FFmpeg libraries in your commercial program, but you
streams. 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
@end itemize mailing list following the guidelines illustrated in the remainder of
this document.
@section Integrating libavcodec or libavformat in your program
For more detailed legal information about the use of FFmpeg in
You can integrate all the source code of the libraries to link them external programs read the @file{LICENSE} file in the source tree and
statically to avoid any version problem. All you need is to provide a consult @url{http://ffmpeg.org/legal.html}.
'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 Contributing @section Contributing
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment