@chapter Developers Guide
@section API
+
@itemize @bullet
@item libavcodec is the library containing the codecs (both encoding and
decoding). Look at @file{libavcodec/apiexample.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
+demux code for several formats). Look at @file{avplay.c} to use it in a
player. See @file{libavformat/output-example.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 Libav mailing list.
+@section Integrating libav in your program
+
+Shared libraries should be used whenever is possible in order to reduce
+the effort distributors have to pour to support programs and to ensure
+only the public API is used.
+
+You can use Libav in your commercial program, but you must abide to the
+license, LGPL or GPL depending on the specific features used, please refer
+to @uref{http://libav.org/legal.html, our legal page} for a quick checklist and to
+the following links for the exact text of each license:
+@uref{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.GPLv2, GPL version 2},
+@uref{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.GPLv3, GPL version 3},
+@uref{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.LGPLv2.1, LGPL version 2.1},
+@uref{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.LGPLv3, LGPL version 3}.
+Any modification to the source code can be suggested for inclusion.
+The best way to proceed is to send your patches to the
+@uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel}
+mailing list.
@anchor{Coding Rules}
@section Coding Rules
-Libav is programmed in the ISO C90 language with a few additional
-features from ISO C99, namely:
+@subsection Code formatting conventions
+The code is written in K&R C style. That means the following:
+
@itemize @bullet
@item
-the @samp{inline} keyword;
-@item
-@samp{//} comments;
-@item
-designated struct initializers (@samp{struct s x = @{ .i = 17 @};})
-@item
-compound literals (@samp{x = (struct s) @{ 17, 23 @};})
-@end itemize
+The control statements are formatted by putting space between the statement
+and parenthesis in the following way:
+@example
+for (i = 0; i < filter->input_count; i++) @{
+@end example
-These features are supported by all compilers we care about, so we will not
-accept patches to remove their use unless they absolutely do not impair
-clarity and performance.
+@item
+The case statement is always located at the same level as the switch itself:
+@example
+switch (link->init_state) @{
+case AVLINK_INIT:
+ continue;
+case AVLINK_STARTINIT:
+ av_log(filter, AV_LOG_INFO, "circular filter chain detected");
+ return 0;
+@end example
-All code must compile with GCC 2.95 and GCC 3.3. Currently, Libav also
-compiles with several other compilers, such as the Compaq ccc compiler
-or Sun Studio 9, and we would like to keep it that way unless it would
-be exceedingly involved. To ensure compatibility, please do not use any
-additional C99 features or GCC extensions. Especially watch out for:
-@itemize @bullet
@item
-mixing statements and declarations;
+Braces in function definitions are written on the new line:
+@example
+const char *avfilter_configuration(void)
+@{
+ return LIBAV_CONFIGURATION;
+@}
+@end example
+
@item
-@samp{long long} (use @samp{int64_t} instead);
+Do not check for NULL values by comparison, @samp{if (p)} and
+@samp{if (!p)} are correct; @samp{if (p == NULL)} and @samp{if (p != NULL)}
+are not.
+
@item
-@samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar;
+In case of a single-statement if, no curly braces are required:
+@example
+if (!pic || !picref)
+ goto fail;
+@end example
+
@item
-GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
+Do not put spaces immediately inside parentheses. @samp{if (ret)} is
+a valid style; @samp{if ( ret )} is not.
@end itemize
+There are the following guidelines regarding the indentation in files:
+
+@itemize @bullet
+@item
Indent size is 4.
-The presentation is one inspired by 'indent -i4 -kr -nut'.
+
+@item
The TAB character is forbidden outside of Makefiles as is any
form of trailing whitespace. Commits containing either will be
rejected by the git repository.
+@item
+You should try to limit your code lines to 80 characters; however, do so if
+and only if this improves readability.
+@end itemize
+The presentation is one inspired by 'indent -i4 -kr -nut'.
+
The main priority in Libav is simplicity and small code size in order to
minimize the bug count.
-Comments: Use the JavaDoc/Doxygen
-format (see examples below) so that code documentation
+@subsection Comments
+Use the JavaDoc/Doxygen format (see examples below) so that code documentation
can be generated automatically. All nontrivial functions should have a comment
above them explaining what the function does, even if it is just one sentence.
All structures and their member variables should be documented, too.
+
+Avoid Qt-style and similar Doxygen syntax with @code{!} in it, i.e. replace
+@code{//!} with @code{///} and similar. Also @@ syntax should be employed
+for markup commands, i.e. use @code{@@param} and not @code{\param}.
+
@example
/**
- * @@file mpeg.c
+ * @@file
* MPEG codec.
* @@author ...
*/
* more text ...
* ...
*/
-typedef struct Foobar@{
+typedef struct Foobar @{
int var1; /**< var1 description */
int var2; ///< var2 description
/** var3 description */
...
@end example
+@subsection C language features
+
+Libav is programmed in the ISO C90 language with a few additional
+features from ISO C99, namely:
+
+@itemize @bullet
+@item
+the @samp{inline} keyword;
+
+@item
+@samp{//} comments;
+
+@item
+designated struct initializers (@samp{struct s x = @{ .i = 17 @};})
+
+@item
+compound literals (@samp{x = (struct s) @{ 17, 23 @};})
+@end itemize
+
+These features are supported by all compilers we care about, so we will not
+accept patches to remove their use unless they absolutely do not impair
+clarity and performance.
+
+All code must compile with recent versions of GCC and a number of other
+currently supported compilers. To ensure compatibility, please do not use
+additional C99 features or GCC extensions. Especially watch out for:
+
+@itemize @bullet
+@item
+mixing statements and declarations;
+
+@item
+@samp{long long} (use @samp{int64_t} instead);
+
+@item
+@samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar;
+
+@item
+GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
+@end itemize
+
+@subsection Naming conventions
+All names should be composed with underscores (_), not CamelCase. For example,
+@samp{avfilter_get_video_buffer} is an acceptable function name and
+@samp{AVFilterGetVideo} is not. The only exception are structure
+names; they should always be CamelCase.
+
+There are the following conventions for naming variables and functions:
+
+@itemize @bullet
+@item
+For local variables no prefix is required.
+
+@item
+For file-scope variables and functions declared as @code{static}, no prefix
+is required.
+
+@item
+For variables and functions visible outside of file scope, but only used
+internally by a library, an @code{ff_} prefix should be used,
+e.g. @samp{ff_w64_demuxer}.
+
+@item
+For variables and functions visible outside of file scope, used internally
+across multiple libraries, use @code{avpriv_} as prefix, for example,
+@samp{avpriv_aac_parse_header}.
+
+@item
+For externally visible symbols, each library has its own prefix. Check
+the existing code and choose names accordingly.
+@end itemize
+
+Furthermore, name space reserved for the system should not be invaded.
+Identifiers ending in @code{_t} are reserved by
+@url{http://pubs.opengroup.org/onlinepubs/007904975/functions/xsh_chap02_02.html#tag_02_02_02, POSIX}.
+Also avoid names starting with @code{__} or @code{_} followed by an uppercase
+letter as they are reserved by the C standard. Names starting with @code{_}
+are reserved at the file level and may not be used for externally visible
+symbols. If in doubt, just avoid names starting with @code{_} altogether.
+
+@subsection Miscellaneous conventions
+
+@itemize @bullet
+@item
fprintf and printf are forbidden in libavformat and libavcodec,
please use av_log() instead.
+@item
Casts should be used only when necessary. Unneeded parentheses
should also be avoided if they don't make the code easier to understand.
+@end itemize
+
+@subsection Editor configuration
+In order to configure Vim to follow Libav formatting conventions, paste
+the following snippet into your @file{.vimrc}:
+@example
+" Indentation rules for Libav: 4 spaces, no tabs.
+set expandtab
+set shiftwidth=4
+set softtabstop=4
+set cindent
+set cinoptions=(0
+" Allow tabs in Makefiles.
+autocmd FileType make,automake set noexpandtab shiftwidth=8 softtabstop=8
+" Trailing whitespace and tabs are forbidden, so highlight them.
+highlight ForbiddenWhitespace ctermbg=red guibg=red
+match ForbiddenWhitespace /\s\+$\|\t/
+" Do not highlight spaces at the end of line while typing on that line.
+autocmd InsertEnter * match ForbiddenWhitespace /\t\|\s\+\%#\@@<!$/
+@end example
+
+For Emacs, add these roughly equivalent lines to your @file{.emacs.d/init.el}:
+@example
+(c-add-style "libav"
+ '("k&r"
+ (c-basic-offset . 4)
+ (indent-tabs-mode . nil)
+ (show-trailing-whitespace . t)
+ (c-offsets-alist
+ (statement-cont . (c-lineup-assignments +)))
+ )
+ )
+(setq c-default-style "libav")
+@end example
@section Development Policy
@enumerate
@item
- Contributions should be licensed under the LGPL 2.1, including an
- "or any later version" clause, or the MIT license. GPL 2 including
- an "or any later version" clause is also acceptable, but LGPL is
- preferred.
-@item
- You must not commit code which breaks Libav! (Meaning unfinished but
- enabled code which breaks compilation or compiles but does not work or
- breaks the regression tests)
- You can commit unfinished stuff (for testing etc), but it must be disabled
- (#ifdef etc) by default so it does not interfere with other developers'
- work.
-@item
- You do not have to over-test things. If it works for you, and you think it
- should work for others, then commit. If your code has problems
- (portability, triggers compiler bugs, unusual environment etc) they will be
- reported and eventually fixed.
-@item
- Do not commit unrelated changes together, split them into self-contained
- pieces. Also do not forget that if part B depends on part A, but A does not
- depend on B, then A can and should be committed first and separate from B.
- Keeping changes well split into self-contained parts makes reviewing and
- understanding them on the commit log mailing list easier. This also helps
- in case of debugging later on.
- Also if you have doubts about splitting or not splitting, do not hesitate to
- ask/discuss it on the developer mailing list.
-@item
- Do not change behavior of the programs (renaming options etc) or public
- API or ABI without first discussing it on the libav-devel mailing list.
- Do not remove functionality from the code. Just improve!
-
- Note: Redundant code can be removed.
-@item
- Do not commit changes to the build system (Makefiles, configure script)
- which change behavior, defaults etc, without asking first. The same
- applies to compiler warning fixes, trivial looking fixes and to code
- maintained by other developers. We usually have a reason for doing things
- the way we do. Send your changes as patches to the libav-devel mailing
- list, and if the code maintainers say OK, you may commit. This does not
- apply to files you wrote and/or maintain.
-@item
- We refuse source indentation and other cosmetic changes if they are mixed
- with functional changes, such commits will be rejected and removed. Every
- developer has his own indentation style, you should not change it. Of course
- if you (re)write something, you can use your own style, even though we would
- prefer if the indentation throughout Libav was consistent (Many projects
- force a given indentation style - we do not.). If you really need to make
- indentation changes (try to avoid this), separate them strictly from real
- changes.
-
- NOTE: If you had to put if()@{ .. @} over a large (> 5 lines) chunk of code,
- then either do NOT change the indentation of the inner part within (do not
- move it to the right)! or do so in a separate commit
-@item
- Always fill out the commit log message. Describe in a few lines what you
- changed and why. You can refer to mailing list postings if you fix a
- particular bug. Comments such as "fixed!" or "Changed it." are unacceptable.
-@item
- If you apply a patch by someone else, include the name and email address in
- the log message. Since the libav-commits mailing list is publicly
- archived you should add some SPAM protection to the email address. Send an
- answer to libav-devel (or wherever you got the patch from) saying that
- you applied the patch.
-@item
- When applying patches that have been discussed (at length) on the mailing
- list, reference the thread in the log message.
-@item
- Do NOT commit to code actively maintained by others without permission.
- Send a patch to libav-devel instead. If no one answers within a reasonable
- timeframe (12h for build failures and security fixes, 3 days small changes,
- 1 week for big patches) then commit your patch if you think it is OK.
- Also note, the maintainer can simply ask for more time to review!
-@item
- Subscribe to the libav-commits mailing list. The diffs of all commits
- are sent there and reviewed by all the other developers. Bugs and possible
- improvements or general questions regarding commits are discussed there. We
- expect you to react if problems with your code are uncovered.
-@item
- Update the documentation if you change behavior or add features. If you are
- unsure how best to do this, send a patch to libav-devel, the documentation
- maintainer(s) will review and commit your stuff.
-@item
- Try to keep important discussions and requests (also) on the public
- developer mailing list, so that all developers can benefit from them.
-@item
- Never write to unallocated memory, never write over the end of arrays,
- always check values read from some untrusted source before using them
- as array index or other risky things.
-@item
- Remember to check if you need to bump versions for the specific libav
- parts (libavutil, libavcodec, libavformat) you are changing. You need
- to change the version integer.
- Incrementing the first component means no backward compatibility to
- previous versions (e.g. removal of a function from the public API).
- Incrementing the second component means backward compatible change
- (e.g. addition of a function to the public API or extension of an
- existing data structure).
- Incrementing the third component means a noteworthy binary compatible
- change (e.g. encoder bug fix that matters for the decoder).
-@item
- Compiler warnings indicate potential bugs or code with bad style. If a type of
- warning always points to correct and clean code, that warning should
- be disabled, not the code changed.
- Thus the remaining warnings can either be bugs or correct code.
- If it is a bug, the bug has to be fixed. If it is not, the code should
- be changed to not generate a warning unless that causes a slowdown
- or obfuscates the code.
-@item
- If you add a new file, give it a proper license header. Do not copy and
- paste it from a random place, use an existing file as template.
+Contributions should be licensed under the
+@uref{http://www.gnu.org/licenses/lgpl-2.1.html, LGPL 2.1},
+including an "or any later version" clause, or, if you prefer
+a gift-style license, the
+@uref{http://opensource.org/licenses/isc-license.txt, ISC} or
+@uref{http://mit-license.org/, MIT} license.
+@uref{http://www.gnu.org/licenses/gpl-2.0.html, GPL 2} including
+an "or any later version" clause is also acceptable, but LGPL is
+preferred.
+
+@item
+All the patches MUST be reviewed in the mailing list before they are
+committed.
+
+@item
+The Libav coding style should remain consistent. Changes to
+conform will be suggested during the review or implemented on commit.
+
+@item
+Patches should be generated using @code{git format-patch} or directly sent
+using @code{git send-email}.
+Please make sure you give the proper credit by setting the correct author
+in the commit.
+
+@item
+The commit message should have a short first line in the form of
+a @samp{topic: short description} as a header, separated by a newline
+from the body consisting of an explanation of why the change is necessary.
+If the commit fixes a known bug on the bug tracker, the commit message
+should include its bug ID. Referring to the issue on the bug tracker does
+not exempt you from writing an excerpt of the bug in the commit message.
+If the patch is a bug fix which should be backported to stable releases,
+i.e. a non-API/ABI-breaking bug fix, add @code{CC: libav-stable@@libav.org}
+to the bottom of your commit message, and make sure to CC your patch to
+this address, too. Some git setups will do this automatically.
+
+@item
+Work in progress patches should be sent to the mailing list with the [WIP]
+or the [RFC] tag.
+
+@item
+Branches in public personal repos are advised as way to
+work on issues collaboratively.
+
+@item
+You do not have to over-test things. If it works for you and you think it
+should work for others, send it to the mailing list for review.
+If you have doubt about portability please state it in the submission so
+people with specific hardware could test it.
+
+@item
+Do not commit unrelated changes together, split them into self-contained
+pieces. Also do not forget that if part B depends on part A, but A does not
+depend on B, then A can and should be committed first and separate from B.
+Keeping changes well split into self-contained parts makes reviewing and
+understanding them on the commit log mailing list easier. This also helps
+in case of debugging later on.
+
+@item
+Patches that change behavior of the programs (renaming options etc) or
+public API or ABI should be discussed in depth and possible few days should
+pass between discussion and commit.
+Changes to the build system (Makefiles, configure script) which alter
+the expected behavior should be considered in the same regard.
+
+@item
+When applying patches that have been discussed (at length) on the mailing
+list, reference the thread in the log message.
+
+@item
+Subscribe to the
+@uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel} and
+@uref{https://lists.libav.org/mailman/listinfo/libav-commits, libav-commits}
+mailing lists.
+Bugs and possible improvements or general questions regarding commits
+are discussed on libav-devel. We expect you to react if problems with
+your code are uncovered.
+
+@item
+Update the documentation if you change behavior or add features. If you are
+unsure how best to do this, send an [RFC] patch to libav-devel.
+
+@item
+All discussions and decisions should be reported on the public developer
+mailing list, so that there is a reference to them.
+Other media (e.g. IRC) should be used for coordination and immediate
+collaboration.
+
+@item
+Never write to unallocated memory, never write over the end of arrays,
+always check values read from some untrusted source before using them
+as array index or other risky things. Always use valgrind to double-check.
+
+@item
+Remember to check if you need to bump versions for the specific libav
+parts (libavutil, libavcodec, libavformat) you are changing. You need
+to change the version integer.
+Incrementing the first component means no backward compatibility to
+previous versions (e.g. removal of a function from the public API).
+Incrementing the second component means backward compatible change
+(e.g. addition of a function to the public API or extension of an
+existing data structure).
+Incrementing the third component means a noteworthy binary compatible
+change (e.g. encoder bug fix that matters for the decoder).
+
+@item
+Compiler warnings indicate potential bugs or code with bad style.
+If it is a bug, the bug has to be fixed. If it is not, the code should
+be changed to not generate a warning unless that causes a slowdown
+or obfuscates the code.
+If a type of warning leads to too many false positives, that warning
+should be disabled, not the code changed.
+
+@item
+If you add a new file, give it a proper license header. Do not copy and
+paste it from a random place, use an existing file as template.
@end enumerate
We think our rules are not too hard. If you have comments, contact us.
-Note, these rules are mostly borrowed from the MPlayer project.
-
@section Submitting patches
-First, (@pxref{Coding Rules}) above if you did not yet.
-
-When you submit your patch, try to send a unified diff (diff '-up'
-option). We cannot read other diffs :-)
+First, read the @ref{Coding Rules} above if you did not yet, in particular
+the rules regarding patch submission.
-Also please do not submit a patch which contains several unrelated changes.
+As stated already, please do not submit a patch which contains several
+unrelated changes.
Split it into separate, self-contained pieces. This does not mean splitting
file by file. Instead, make the patch as small as possible while still
keeping it as a logical unit that contains an individual change, even
Use the patcheck tool of Libav to check your patch.
The tool is located in the tools directory.
-Run the regression tests before submitting a patch so that you can
-verify that there are no big problems.
-
-Patches should be posted as base64 encoded attachments (or any other
-encoding which ensures that the patch will not be trashed during
-transmission) to the libav-devel mailing list, see
-@url{https://lists.libav.org/mailman/listinfo/libav-devel}
+Run the @ref{Regression Tests} before submitting a patch in order to verify
+it does not cause unexpected problems.
It also helps quite a bit if you tell us what the patch does (for example
'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant
-and has no lrint()')
+and has no lrint()'). This kind of explanation should be the body of the
+commit message.
Also please if you send several patches, send each patch as a separate mail,
do not attach several unrelated patches to the same mail.
+Patches should be posted to the
+@uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel}
+mailing list. Use @code{git send-email} when possible since it will properly
+send patches without requiring extra care. If you cannot, then send patches
+as base64-encoded attachments, so your patch is not trashed during
+transmission.
+
Your patch will be reviewed on the mailing list. You will likely be asked
to make some changes and are expected to send in an improved version that
incorporates the requests from the review. This process may go through
-several iterations. Once your patch is deemed good enough, some developer
-will pick it up and commit it to the official Libav tree.
+several iterations. Once your patch is deemed good enough, it will be
+committed to the official Libav tree.
Give us a few days to react. But if some time passes without reaction,
send a reminder by email. Your patch should eventually be dealt with.
@enumerate
@item
- Did you use av_cold for codec initialization and close functions?
+Did you use av_cold for codec initialization and close functions?
+
+@item
+Did you add a long_name under NULL_IF_CONFIG_SMALL to the AVCodec or
+AVInputFormat/AVOutputFormat struct?
+
@item
- Did you add a long_name under NULL_IF_CONFIG_SMALL to the AVCodec or
- AVInputFormat/AVOutputFormat struct?
+Did you bump the minor version number (and reset the micro version
+number) in @file{libavcodec/version.h} or @file{libavformat/version.h}?
+
@item
- Did you bump the minor version number (and reset the micro version
- number) in @file{avcodec.h} or @file{avformat.h}?
+Did you register it in @file{allcodecs.c} or @file{allformats.c}?
+
@item
- Did you register it in @file{allcodecs.c} or @file{allformats.c}?
+Did you add the AVCodecID to @file{avcodec.h}?
+When adding new codec IDs, also add an entry to the codec descriptor
+list in @file{libavcodec/codec_desc.c}.
+
@item
- Did you add the CodecID to @file{avcodec.h}?
+If it has a FourCC, did you add it to @file{libavformat/riff.c},
+even if it is only a decoder?
+
@item
- If it has a fourcc, did you add it to @file{libavformat/riff.c},
- even if it is only a decoder?
+Did you add a rule to compile the appropriate files in the Makefile?
+Remember to do this even if you are just adding a format to a file that
+is already being compiled by some other rule, like a raw demuxer.
+
@item
- Did you add a rule to compile the appropriate files in the Makefile?
- Remember to do this even if you're just adding a format to a file that is
- already being compiled by some other rule, like a raw demuxer.
+Did you add an entry to the table of supported formats or codecs in
+@file{doc/general.texi}?
+
@item
- Did you add an entry to the table of supported formats or codecs in
- @file{doc/general.texi}?
+Did you add an entry in the Changelog?
+
@item
- Did you add an entry in the Changelog?
+If it depends on a parser or a library, did you add that dependency in
+configure?
+
@item
- If it depends on a parser or a library, did you add that dependency in
- configure?
+Did you @code{git add} the appropriate files before committing?
+
@item
- Did you "git add" the appropriate files before committing?
+Did you make sure it compiles standalone, i.e. with
+@code{configure --disable-everything --enable-decoder=foo}
+(or @code{--enable-demuxer} or whatever your component is)?
@end enumerate
+
@section patch submission checklist
@enumerate
@item
- Do the regression tests pass with the patch applied?
-@item
- Does @code{make checkheaders} pass with the patch applied?
-@item
- Is the patch a unified diff?
-@item
- Is the patch against latest Libav git master branch?
+Does @code{make check} pass with the patch applied?
+
@item
- Are you subscribed to ffmpeg-dev?
- (the list is subscribers only due to spam)
+Is the patch against latest Libav git master branch?
+
@item
- Have you checked that the changes are minimal, so that the same cannot be
- achieved with a smaller patch and/or simpler final code?
+Are you subscribed to the
+@uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel}
+mailing list? (Only list subscribers are allowed to post.)
+
@item
- If the change is to speed critical code, did you benchmark it?
+Have you checked that the changes are minimal, so that the same cannot be
+achieved with a smaller patch and/or simpler final code?
+
@item
- If you did any benchmarks, did you provide them in the mail?
+If the change is to speed critical code, did you benchmark it?
+
@item
- Have you checked that the patch does not introduce buffer overflows or
- other security issues?
+If you did any benchmarks, did you provide them in the mail?
+
@item
- Did you test your decoder or demuxer against damaged data? If no, see
- tools/trasher and the noise bitstream filter. Your decoder or demuxer
- should not crash or end in a (near) infinite loop when fed damaged data.
+Have you checked that the patch does not introduce buffer overflows or
+other security issues?
+
@item
- Is the patch created from the root of the source tree, so it can be
- applied with @code{patch -p0}?
+Did you test your decoder or demuxer against damaged data? If no, see
+tools/trasher, the noise bitstream filter, and
+@uref{http://caca.zoy.org/wiki/zzuf, zzuf}. Your decoder or demuxer
+should not crash, end in a (near) infinite loop, or allocate ridiculous
+amounts of memory when fed damaged data.
+
@item
- Does the patch not mix functional and cosmetic changes?
+Does the patch not mix functional and cosmetic changes?
+
@item
- Did you add tabs or trailing whitespace to the code? Both are forbidden.
+Did you add tabs or trailing whitespace to the code? Both are forbidden.
+
@item
- Is the patch attached to the email you send?
+Is the patch attached to the email you send?
+
@item
- Is the mime type of the patch correct? It should be text/x-diff or
- text/x-patch or at least text/plain and not application/octet-stream.
+Is the mime type of the patch correct? It should be text/x-diff or
+text/x-patch or at least text/plain and not application/octet-stream.
+
@item
- If the patch fixes a bug, did you provide a verbose analysis of the bug?
+If the patch fixes a bug, did you provide a verbose analysis of the bug?
+
@item
- If the patch fixes a bug, did you provide enough information, including
- a sample, so the bug can be reproduced and the fix can be verified?
- Note please do not attach samples >100k to mails but rather provide a
- URL, you can upload to ftp://upload.libav.org
+If the patch fixes a bug, did you provide enough information, including
+a sample, so the bug can be reproduced and the fix can be verified?
+Note please do not attach samples >100k to mails but rather provide a
+URL, you can upload to ftp://upload.libav.org
+
@item
- Did you provide a verbose summary about what the patch does change?
+Did you provide a verbose summary about what the patch does change?
+
@item
- Did you provide a verbose explanation why it changes things like it does?
+Did you provide a verbose explanation why it changes things like it does?
+
@item
- Did you provide a verbose summary of the user visible advantages and
- disadvantages if the patch is applied?
+Did you provide a verbose summary of the user visible advantages and
+disadvantages if the patch is applied?
+
@item
- Did you provide an example so we can verify the new feature added by the
- patch easily?
+Did you provide an example so we can verify the new feature added by the
+patch easily?
+
@item
- If you added a new file, did you insert a license header? It should be
- taken from Libav, not randomly copied and pasted from somewhere else.
+If you added a new file, did you insert a license header? It should be
+taken from Libav, not randomly copied and pasted from somewhere else.
+
@item
- You should maintain alphabetical order in alphabetically ordered lists as
- long as doing so does not break API/ABI compatibility.
+You should maintain alphabetical order in alphabetically ordered lists as
+long as doing so does not break API/ABI compatibility.
+
@item
- Lines with similar content should be aligned vertically when doing so
- improves readability.
+Lines with similar content should be aligned vertically when doing so
+improves readability.
+
@item
- Did you provide a suggestion for a clear commit log message?
+Make sure you check the return values of function and return appropriate
+error codes. Especially memory allocation functions like @code{malloc()}
+are notoriously left unchecked, which is a serious problem.
@end enumerate
@section Patch review process
-All patches posted to libav-devel will be reviewed, unless they contain a
+All patches posted to the
+@uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel}
+mailing list will be reviewed, unless they contain a
clear note that the patch is not for the git master branch.
Reviews and comments will be posted as replies to the patch on the
mailing list. The patch submitter then has to take care of every comment,
We will review all submitted patches, but sometimes we are quite busy so
especially for large patches this can take several weeks.
-When resubmitting patches, please do not make any significant changes
-not related to the comments received during review. Such patches will
-be rejected. Instead, submit significant changes or new features as
-separate patches.
+When resubmitting patches, if their size grew or during the review different
+issues arisen please split the patch so each issue has a specific patch.
+
+@anchor{Regression Tests}
+@section Regression Tests
-@section Regression tests
+Before submitting a patch (or committing to the repository), you should at
+least make sure that it does not break anything.
-Before submitting a patch (or committing to the repository), you should at least
-test that you did not break anything.
+If the code changed has already a test present in FATE you should run it,
+otherwise it is advised to add it.
-The regression tests build a synthetic video stream and a synthetic
-audio stream. These are then encoded and decoded with all codecs or
-formats. The CRC (or MD5) of each generated file is recorded in a
-result file. A 'diff' is launched to compare the reference results and
-the result file. The output is checked immediately after each test
-has run.
+Improvements to codec or demuxer might change the FATE results. Make sure
+to commit the update reference with the change and to explain in the comment
+why the expected result changed.
-The regression tests then go on to test the FFserver code with a
-limited set of streams. It is important that this step runs correctly
-as well.
+Please refer to @url{fate.html}.
-Run 'make test' to test all the codecs and formats. Commands like
-'make regtest-mpeg2' can be used to run a single test. By default,
-make will abort if any test fails. To run all tests regardless,
-use make -k. To get a more verbose output, use 'make V=1 test' or
-'make V=2 test'.
+@subsection Visualizing Test Coverage
-Run 'make fulltest' to test all the codecs, formats and FFserver.
+The Libav build system allows visualizing the test coverage in an easy
+manner with the coverage tools @code{gcov}/@code{lcov}. This involves
+the following steps:
-[Of course, some patches may change the results of the regression tests. In
-this case, the reference results of the regression tests shall be modified
-accordingly].
+@enumerate
+@item
+ Configure to compile with instrumentation enabled:
+ @code{configure --toolchain=gcov}.
+
+@item
+ Run your test case, either manually or via FATE. This can be either
+ the full FATE regression suite, or any arbitrary invocation of any
+ front-end tool provided by Libav, in any combination.
+
+@item
+ Run @code{make lcov} to generate coverage data in HTML format.
+
+@item
+ View @code{lcov/index.html} in your preferred HTML viewer.
+@end enumerate
+
+You can use the command @code{make lcov-reset} to reset the coverage
+measurements. You will need to rerun @code{make lcov} after running a
+new test.
+
+@subsection Using Valgrind
+
+The configure script provides a shortcut for using valgrind to spot bugs
+related to memory handling. Just add the option
+@code{--toolchain=valgrind-memcheck} or @code{--toolchain=valgrind-massif}
+to your configure line, and reasonable defaults will be set for running
+FATE under the supervision of either the @strong{memcheck} or the
+@strong{massif} tool of the valgrind suite.
+
+In case you need finer control over how valgrind is invoked, use the
+@code{--target-exec='valgrind <your_custom_valgrind_options>} option in
+your configure line instead.
+
+@anchor{Release process}
+@section Release process
+
+Libav maintains a set of @strong{release branches}, which are the
+recommended deliverable for system integrators and distributors (such as
+Linux distributions, etc.). At irregular times, a @strong{release
+manager} prepares, tests and publishes tarballs on the
+@url{http://libav.org} website.
+
+There are two kinds of releases:
+
+@enumerate
+@item
+@strong{Major releases} always include the latest and greatest
+features and functionality.
+
+@item
+@strong{Point releases} are cut from @strong{release} branches,
+which are named @code{release/X}, with @code{X} being the release
+version number.
+@end enumerate
+
+Note that we promise to our users that shared libraries from any Libav
+release never break programs that have been @strong{compiled} against
+previous versions of @strong{the same release series} in any case!
+
+However, from time to time, we do make API changes that require adaptations
+in applications. Such changes are only allowed in (new) major releases and
+require further steps such as bumping library version numbers and/or
+adjustments to the symbol versioning file. Please discuss such changes
+on the @strong{libav-devel} mailing list in time to allow forward planning.
+
+@anchor{Criteria for Point Releases}
+@subsection Criteria for Point Releases
+
+Changes that match the following criteria are valid candidates for
+inclusion into a point release:
+
+@enumerate
+@item
+Fixes a security issue, preferably identified by a @strong{CVE
+number} issued by @url{http://cve.mitre.org/}.
+
+@item
+Fixes a documented bug in @url{http://bugzilla.libav.org}.
+
+@item
+Improves the included documentation.
+
+@item
+Retains both source code and binary compatibility with previous
+point releases of the same release branch.
+@end enumerate
+
+The order for checking the rules is (1 OR 2 OR 3) AND 4.
+
+All Libav developers are welcome to nominate commits that they push to
+@code{master} by mailing the @strong{libav-stable} mailing list. The
+easiest way to do so is to include @code{CC: libav-stable@@libav.org} in
+the commit message.
+
+
+@subsection Release Checklist
+
+The release process involves the following steps:
+
+@enumerate
+@item
+Ensure that the @file{RELEASE} file contains the version number for
+the upcoming release.
+
+@item
+File a release tracking bug in @url{http://bugzilla.libav.org}. Make
+sure that the bug has an alias named @code{ReleaseX.Y} for the
+@code{X.Y} release.
+
+@item
+Announce the intent to do a release to the mailing list.
+
+@item
+Reassign unresolved blocking bugs from previous release
+tracking bugs to the new bug.
+
+@item
+Review patch nominations that reach the @strong{libav-stable}
+mailing list, and push patches that fulfill the stable release
+criteria to the release branch.
+
+@item
+Ensure that the FATE regression suite still passes in the release
+branch on at least @strong{i386} and @strong{amd64}
+(cf. @ref{Regression Tests}).
+
+@item
+Prepare the release tarballs in @code{xz} and @code{gz} formats, and
+supplementing files that contain @code{md5} and @code{sha1}
+checksums.
+
+@item
+Publish the tarballs at @url{http://libav.org/releases}. Create and
+push an annotated tag in the form @code{vX}, with @code{X}
+containing the version number.
+
+@item
+Build the tarballs with the Windows binaries, and publish them at
+@url{http://win32.libav.org/releases}.
+
+@item
+Propose and send a patch to the @strong{libav-devel} mailing list
+with a news entry for the website.
+
+@item
+Publish the news entry.
+
+@item
+Send announcement to the mailing list.
+@end enumerate
@bye