yading10: \input texinfo yading10: yading10: Developer Documentation yading10: yading10: Developer Documentation yading10: titlepage yading10: yading10: yading10: yading10: yading10: yading10: Developers Guide yading10: yading10: API yading10: * yading10: libavcodec is the library containing the codecs (both encoding and yading10: decoding). Look at doc/examples/decoding_encoding.c to see how to use yading10: it. yading10: yading10: libavformat is the library containing the file format handling (mux and yading10: demux code for several formats). Look at ffplay.c to use it in a yading10: player. See doc/examples/muxing.c to use it to generate audio or video yading10: streams. yading10: yading10: itemize yading10: yading10: Integrating libavcodec or libavformat in your program yading10: yading10: You can integrate all the source code of the libraries to link them yading10: statically to avoid any version problem. All you need is to provide a yading10: 'config.mak' and a 'config.h' in the parent directory. See the defines yading10: generated by ./configure to understand what is needed. yading10: yading10: You can use libavcodec or libavformat in your commercial program, but yading10: any patch you make must be published. The best way to proceed is yading10: to send your patches to the FFmpeg mailing list. yading10: yading10: Contributing yading10: yading10: There are 3 ways by which code gets into ffmpeg. yading10: * yading10: Submitting Patches to the main developer mailing list yading10:       see Submitting patches for details. yading10: Directly committing changes to the main tree. yading10: Committing changes to a git clone, for example on github.com or yading10:       gitorious.org. And asking us to merge these changes. yading10: itemize yading10: yading10: Whichever way, changes should be reviewed by the maintainer of the code yading10: before they are committed. And they should follow the Coding Rules. yading10: The developer making the commit and the author are responsible for their changes yading10: and should try to fix issues their commit causes. yading10: yading10: yading10: Coding Rules yading10: yading10: Code formatting conventions yading10: yading10: There are the following guidelines regarding the indentation in files: yading10: * yading10: yading10: Indent size is 4. yading10: yading10: The TAB character is forbidden outside of Makefiles as is any yading10: form of trailing whitespace. Commits containing either will be yading10: rejected by the git repository. yading10: yading10: You should try to limit your code lines to 80 characters; however, do so if yading10: and only if this improves readability. yading10: itemize yading10: The presentation is one inspired by 'indent -i4 -kr -nut'. yading10: yading10: The main priority in FFmpeg is simplicity and small code size in order to yading10: minimize the bug count. yading10: yading10: Comments yading10: Use the JavaDoc/Doxygen  format (see examples below) so that code documentation yading10: can be generated automatically. All nontrivial functions should have a comment yading10: above them explaining what the function does, even if it is just one sentence. yading10: All structures and their member variables should be documented, too. yading10: yading10: Avoid Qt-style and similar Doxygen syntax with ! in it, i.e. replace yading10: //! with /// and similar.  Also @ syntax should be employed yading10: for markup commands, i.e. use @param and not \param. yading10: yading10: yading10: /** yading10:  * @file yading10:  * MPEG codec. yading10:  * @author ... yading10:  */ yading10: yading10: /** yading10:  * Summary sentence. yading10:  * more text ... yading10:  * ... yading10:  */ yading10: typedef struct Foobar{ yading10:     int var1; /**< var1 description */ yading10:     int var2; ///< var2 description yading10:     /** var3 description */ yading10:     int var3; yading10: } Foobar; yading10: yading10: /** yading10:  * Summary sentence. yading10:  * more text ... yading10:  * ... yading10:  * @param my_parameter description of my_parameter yading10:  * @return return value description yading10:  */ yading10: int myfunc(int my_parameter) yading10: ... yading10: example yading10: yading10: C language features yading10: yading10: FFmpeg is programmed in the ISO C90 language with a few additional yading10: features from ISO C99, namely: yading10: * yading10: yading10: the inline keyword; yading10: yading10: // comments; yading10: yading10: designated struct initializers (struct s x = { .i = 17 };) yading10: yading10: compound literals (x = (struct s) { 17, 23 };) yading10: itemize yading10: yading10: These features are supported by all compilers we care about, so we will not yading10: accept patches to remove their use unless they absolutely do not impair yading10: clarity and performance. yading10: yading10: All code must compile with recent versions of GCC and a number of other yading10: currently supported compilers. To ensure compatibility, please do not use yading10: additional C99 features or GCC extensions. Especially watch out for: yading10: * yading10: yading10: mixing statements and declarations; yading10: yading10: long long (use int64_t instead); yading10: yading10: __attribute__ not protected by #ifdef __GNUC__ or similar; yading10: yading10: GCC statement expressions ((x = ({ int y = 4; y; })). yading10: itemize yading10: yading10: Naming conventions yading10: All names should be composed with underscores (_), not CamelCase. For example, yading10: avfilter_get_video_buffer is an acceptable function name and yading10: AVFilterGetVideo is not. The exception from this are type names, like yading10: for example structs and enums; they should always be in the CamelCase yading10: yading10: There are the following conventions for naming variables and functions: yading10: * yading10: yading10: For local variables no prefix is required. yading10: yading10: For file-scope variables and functions declared as static, no prefix yading10: is required. yading10: yading10: For variables and functions visible outside of file scope, but only used yading10: internally by a library, an ff_ prefix should be used, yading10: e.g. ff_w64_demuxer. yading10: yading10: For variables and functions visible outside of file scope, used internally yading10: across multiple libraries, use avpriv_ as prefix, for example, yading10: avpriv_aac_parse_header. yading10: yading10: Each library has its own prefix for public symbols, in addition to the yading10: commonly used av_ (avformat_ for libavformat, yading10: avcodec_ for libavcodec, swr_ for libswresample, etc). yading10: Check the existing code and choose names accordingly. yading10: Note that some symbols without these prefixes are also exported for yading10: retro-compatibility reasons. These exceptions are declared in the yading10: lib<name>/lib<name>.v files. yading10: itemize yading10: yading10: Furthermore, name space reserved for the system should not be invaded. yading10: Identifiers ending in _t are reserved by yading10: POSIX (http://pubs.opengroup.org/onlinepubs/007904975/functions/xsh_chap02_02.html#tag_02_02_02). yading10: Also avoid names starting with __ or _ followed by an uppercase yading10: letter as they are reserved by the C standard. Names starting with _ yading10: are reserved at the file level and may not be used for externally visible yading10: symbols. If in doubt, just avoid names starting with _ altogether. yading10: yading10: Miscellaneous conventions yading10: * yading10: yading10: fprintf and printf are forbidden in libavformat and libavcodec, yading10: please use av_log() instead. yading10: yading10: Casts should be used only when necessary. Unneeded parentheses yading10: should also be avoided if they don't make the code easier to understand. yading10: itemize yading10: yading10: Editor configuration yading10: In order to configure Vim to follow FFmpeg formatting conventions, paste yading10: the following snippet into your .vimrc: yading10: yading10: " indentation rules for FFmpeg: 4 spaces, no tabs yading10: set expandtab yading10: set shiftwidth=4 yading10: set softtabstop=4 yading10: set cindent yading10: set cinoptions=(0 yading10: " Allow tabs in Makefiles. yading10: autocmd FileType make,automake set noexpandtab shiftwidth=8 softtabstop=8 yading10: " Trailing whitespace and tabs are forbidden, so highlight them. yading10: highlight ForbiddenWhitespace ctermbg=red guibg=red yading10: match ForbiddenWhitespace /\s\+$\|\t/ yading10: " Do not highlight spaces at the end of line while typing on that line. yading10: autocmd InsertEnter * match ForbiddenWhitespace /\t\|\s\+\%#\@<!$/ yading10: example yading10: yading10: For Emacs, add these roughly equivalent lines to your .emacs.d/init.el: yading10: yading10: (c-add-style "ffmpeg" yading10:              '("k&r" yading10:                (c-basic-offset . 4) yading10:                (indent-tabs-mode . nil) yading10:                (show-trailing-whitespace . t) yading10:                (c-offsets-alist yading10:                 (statement-cont . (c-lineup-assignments +))) yading10:                ) yading10:              ) yading10: (setq c-default-style "ffmpeg") yading10: example yading10: yading10: Development Policy yading10: yading10: yading10: yading10:    Contributions should be licensed under the yading10:    LGPL 2.1 (http://www.gnu.org/licenses/lgpl-2.1.html), yading10:    including an "or any later version" clause, or, if you prefer yading10:    a gift-style license, the yading10:    ISC (http://www.isc.org/software/license/) or yading10:    MIT (http://mit-license.org/) license. yading10:    GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html) including yading10:    an "or any later version" clause is also acceptable, but LGPL is yading10:    preferred. yading10: yading10:    You must not commit code which breaks FFmpeg! (Meaning unfinished but yading10:    enabled code which breaks compilation or compiles but does not work or yading10:    breaks the regression tests) yading10:    You can commit unfinished stuff (for testing etc), but it must be disabled yading10:    (#ifdef etc) by default so it does not interfere with other developers' yading10:    work. yading10: yading10:    The commit message should have a short first line in the form of yading10:    a topic: short description as a header, separated by a newline yading10:    from the body consisting of an explanation of why the change is necessary. yading10:    If the commit fixes a known bug on the bug tracker, the commit message yading10:    should include its bug ID. Referring to the issue on the bug tracker does yading10:    not exempt you from writing an excerpt of the bug in the commit message. yading10: yading10:    You do not have to over-test things. If it works for you, and you think it yading10:    should work for others, then commit. If your code has problems yading10:    (portability, triggers compiler bugs, unusual environment etc) they will be yading10:    reported and eventually fixed. yading10: yading10:    Do not commit unrelated changes together, split them into self-contained yading10:    pieces. Also do not forget that if part B depends on part A, but A does not yading10:    depend on B, then A can and should be committed first and separate from B. yading10:    Keeping changes well split into self-contained parts makes reviewing and yading10:    understanding them on the commit log mailing list easier. This also helps yading10:    in case of debugging later on. yading10:    Also if you have doubts about splitting or not splitting, do not hesitate to yading10:    ask/discuss it on the developer mailing list. yading10: yading10:    Do not change behavior of the programs (renaming options etc) or public yading10:    API or ABI without first discussing it on the ffmpeg-devel mailing list. yading10:    Do not remove functionality from the code. Just improve! yading10: yading10:    Note: Redundant code can be removed. yading10: yading10:    Do not commit changes to the build system (Makefiles, configure script) yading10:    which change behavior, defaults etc, without asking first. The same yading10:    applies to compiler warning fixes, trivial looking fixes and to code yading10:    maintained by other developers. We usually have a reason for doing things yading10:    the way we do. Send your changes as patches to the ffmpeg-devel mailing yading10:    list, and if the code maintainers say OK, you may commit. This does not yading10:    apply to files you wrote and/or maintain. yading10: yading10:    We refuse source indentation and other cosmetic changes if they are mixed yading10:    with functional changes, such commits will be rejected and removed. Every yading10:    developer has his own indentation style, you should not change it. Of course yading10:    if you (re)write something, you can use your own style, even though we would yading10:    prefer if the indentation throughout FFmpeg was consistent (Many projects yading10:    force a given indentation style - we do not.). If you really need to make yading10:    indentation changes (try to avoid this), separate them strictly from real yading10:    changes. yading10: yading10:    NOTE: If you had to put if(){ .. } over a large (> 5 lines) chunk of code, yading10:    then either do NOT change the indentation of the inner part within (do not yading10:    move it to the right)! or do so in a separate commit yading10: yading10:    Always fill out the commit log message. Describe in a few lines what you yading10:    changed and why. You can refer to mailing list postings if you fix a yading10:    particular bug. Comments such as "fixed!" or "Changed it." are unacceptable. yading10:    Recommended format: yading10:    area changed: Short 1 line description yading10: yading10:    details describing what and why and giving references. yading10: yading10:    Make sure the author of the commit is set correctly. (see git commit --author) yading10:    If you apply a patch, send an yading10:    answer to ffmpeg-devel (or wherever you got the patch from) saying that yading10:    you applied the patch. yading10: yading10:    When applying patches that have been discussed (at length) on the mailing yading10:    list, reference the thread in the log message. yading10: yading10:     Do NOT commit to code actively maintained by others without permission. yading10:     Send a patch to ffmpeg-devel instead. If no one answers within a reasonable yading10:     timeframe (12h for build failures and security fixes, 3 days small changes, yading10:     1 week for big patches) then commit your patch if you think it is OK. yading10:     Also note, the maintainer can simply ask for more time to review! yading10: yading10:     Subscribe to the ffmpeg-cvslog mailing list. The diffs of all commits yading10:     are sent there and reviewed by all the other developers. Bugs and possible yading10:     improvements or general questions regarding commits are discussed there. We yading10:     expect you to react if problems with your code are uncovered. yading10: yading10:     Update the documentation if you change behavior or add features. If you are yading10:     unsure how best to do this, send a patch to ffmpeg-devel, the documentation yading10:     maintainer(s) will review and commit your stuff. yading10: yading10:     Try to keep important discussions and requests (also) on the public yading10:     developer mailing list, so that all developers can benefit from them. yading10: yading10:     Never write to unallocated memory, never write over the end of arrays, yading10:     always check values read from some untrusted source before using them yading10:     as array index or other risky things. yading10: yading10:     Remember to check if you need to bump versions for the specific libav* yading10:     parts (libavutil, libavcodec, libavformat) you are changing. You need yading10:     to change the version integer. yading10:     Incrementing the first component means no backward compatibility to yading10:     previous versions (e.g. removal of a function from the public API). yading10:     Incrementing the second component means backward compatible change yading10:     (e.g. addition of a function to the public API or extension of an yading10:     existing data structure). yading10:     Incrementing the third component means a noteworthy binary compatible yading10:     change (e.g. encoder bug fix that matters for the decoder). The third yading10:     component always starts at 100 to distinguish FFmpeg from Libav. yading10: yading10:     Compiler warnings indicate potential bugs or code with bad style. If a type of yading10:     warning always points to correct and clean code, that warning should yading10:     be disabled, not the code changed. yading10:     Thus the remaining warnings can either be bugs or correct code. yading10:     If it is a bug, the bug has to be fixed. If it is not, the code should yading10:     be changed to not generate a warning unless that causes a slowdown yading10:     or obfuscates the code. yading10: yading10:     If you add a new file, give it a proper license header. Do not copy and yading10:     paste it from a random place, use an existing file as template. yading10: enumerate yading10: yading10: We think our rules are not too hard. If you have comments, contact us. yading10: yading10: yading10: Submitting patches yading10: yading10: First, read the Coding Rules above if you did not yet, in particular yading10: the rules regarding patch submission. yading10: yading10: When you submit your patch, please use git format-patch or yading10: git send-email. We cannot read other diffs :-) yading10: yading10: Also please do not submit a patch which contains several unrelated changes. yading10: Split it into separate, self-contained pieces. This does not mean splitting yading10: file by file. Instead, make the patch as small as possible while still yading10: keeping it as a logical unit that contains an individual change, even yading10: if it spans multiple files. This makes reviewing your patches much easier yading10: for us and greatly increases your chances of getting your patch applied. yading10: yading10: Use the patcheck tool of FFmpeg to check your patch. yading10: The tool is located in the tools directory. yading10: yading10: Run the Regression tests before submitting a patch in order to verify yading10: it does not cause unexpected problems. yading10: yading10: It also helps quite a bit if you tell us what the patch does (for example yading10: 'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant yading10: and has no lrint()') yading10: yading10: Also please if you send several patches, send each patch as a separate mail, yading10: do not attach several unrelated patches to the same mail. yading10: yading10: Patches should be posted to the yading10: ffmpeg-devel (http://lists.ffmpeg.org/mailman/listinfo/ffmpeg-devel) yading10: mailing list. Use git send-email when possible since it will properly yading10: send patches without requiring extra care. If you cannot, then send patches yading10: as base64-encoded attachments, so your patch is not trashed during yading10: transmission. yading10: yading10: Your patch will be reviewed on the mailing list. You will likely be asked yading10: to make some changes and are expected to send in an improved version that yading10: incorporates the requests from the review. This process may go through yading10: several iterations. Once your patch is deemed good enough, some developer yading10: will pick it up and commit it to the official FFmpeg tree. yading10: yading10: Give us a few days to react. But if some time passes without reaction, yading10: send a reminder by email. Your patch should eventually be dealt with. yading10: yading10: yading10: New codecs or formats checklist yading10: yading10: yading10: yading10:     Did you use av_cold for codec initialization and close functions? yading10: yading10:     Did you add a long_name under NULL_IF_CONFIG_SMALL to the AVCodec or yading10:     AVInputFormat/AVOutputFormat struct? yading10: yading10:     Did you bump the minor version number (and reset the micro version yading10:     number) in libavcodec/version.h or libavformat/version.h? yading10: yading10:     Did you register it in allcodecs.c or allformats.c? yading10: yading10:     Did you add the AVCodecID to avcodec.h? yading10:     When adding new codec IDs, also add an entry to the codec descriptor yading10:     list in libavcodec/codec_desc.c. yading10: yading10:     If it has a FourCC, did you add it to libavformat/riff.c, yading10:     even if it is only a decoder? yading10: yading10:     Did you add a rule to compile the appropriate files in the Makefile? yading10:     Remember to do this even if you're just adding a format to a file that is yading10:     already being compiled by some other rule, like a raw demuxer. yading10: yading10:     Did you add an entry to the table of supported formats or codecs in yading10:     doc/general.texi? yading10: yading10:     Did you add an entry in the Changelog? yading10: yading10:     If it depends on a parser or a library, did you add that dependency in yading10:     configure? yading10: yading10:     Did you git add the appropriate files before committing? yading10: yading10:     Did you make sure it compiles standalone, i.e. with yading10:     configure --disable-everything --enable-decoder=foo yading10:     (or --enable-demuxer or whatever your component is)? yading10: enumerate yading10: yading10: yading10: patch submission checklist yading10: yading10: yading10: yading10:     Does make fate pass with the patch applied? yading10: yading10:     Was the patch generated with git format-patch or send-email? yading10: yading10:     Did you sign off your patch? (git commit -s) yading10:     See http://git.kernel.org/?p=linux/kernel/git/torvalds/linux.git;a=blob_plain;f=Documentation/SubmittingPatches for the meaning yading10:     of sign off. yading10: yading10:     Did you provide a clear git commit log message? yading10: yading10:     Is the patch against latest FFmpeg git master branch? yading10: yading10:     Are you subscribed to ffmpeg-devel? yading10:     (the list is subscribers only due to spam) yading10: yading10:     Have you checked that the changes are minimal, so that the same cannot be yading10:     achieved with a smaller patch and/or simpler final code? yading10: yading10:     If the change is to speed critical code, did you benchmark it? yading10: yading10:     If you did any benchmarks, did you provide them in the mail? yading10: yading10:     Have you checked that the patch does not introduce buffer overflows or yading10:     other security issues? yading10: yading10:     Did you test your decoder or demuxer against damaged data? If no, see yading10:     tools/trasher, the noise bitstream filter, and yading10:     zzuf (http://caca.zoy.org/wiki/zzuf). Your decoder or demuxer yading10:     should not crash, end in a (near) infinite loop, or allocate ridiculous yading10:     amounts of memory when fed damaged data. yading10: yading10:     Does the patch not mix functional and cosmetic changes? yading10: yading10:     Did you add tabs or trailing whitespace to the code? Both are forbidden. yading10: yading10:     Is the patch attached to the email you send? yading10: yading10:     Is the mime type of the patch correct? It should be text/x-diff or yading10:     text/x-patch or at least text/plain and not application/octet-stream. yading10: yading10:     If the patch fixes a bug, did you provide a verbose analysis of the bug? yading10: yading10:     If the patch fixes a bug, did you provide enough information, including yading10:     a sample, so the bug can be reproduced and the fix can be verified? yading10:     Note please do not attach samples >100k to mails but rather provide a yading10:     URL, you can upload to ftp://upload.ffmpeg.org yading10: yading10:     Did you provide a verbose summary about what the patch does change? yading10: yading10:     Did you provide a verbose explanation why it changes things like it does? yading10: yading10:     Did you provide a verbose summary of the user visible advantages and yading10:     disadvantages if the patch is applied? yading10: yading10:     Did you provide an example so we can verify the new feature added by the yading10:     patch easily? yading10: yading10:     If you added a new file, did you insert a license header? It should be yading10:     taken from FFmpeg, not randomly copied and pasted from somewhere else. yading10: yading10:     You should maintain alphabetical order in alphabetically ordered lists as yading10:     long as doing so does not break API/ABI compatibility. yading10: yading10:     Lines with similar content should be aligned vertically when doing so yading10:     improves readability. yading10: yading10:     Consider to add a regression test for your code. yading10: yading10:     If you added YASM code please check that things still work with --disable-yasm yading10: yading10:     Make sure you check the return values of function and return appropriate yading10:     error codes. Especially memory allocation functions like av_malloc() yading10:     are notoriously left unchecked, which is a serious problem. yading10: yading10:     Test your code with valgrind and or Address Sanitizer to ensure it's free yading10:     of leaks, out of array accesses, etc. yading10: enumerate yading10: yading10: Patch review process yading10: yading10: All patches posted to ffmpeg-devel will be reviewed, unless they contain a yading10: clear note that the patch is not for the git master branch. yading10: Reviews and comments will be posted as replies to the patch on the yading10: mailing list. The patch submitter then has to take care of every comment, yading10: that can be by resubmitting a changed patch or by discussion. Resubmitted yading10: patches will themselves be reviewed like any other patch. If at some point yading10: a patch passes review with no comments then it is approved, that can for yading10: simple and small patches happen immediately while large patches will generally yading10: have to be changed and reviewed many times before they are approved. yading10: After a patch is approved it will be committed to the repository. yading10: yading10: We will review all submitted patches, but sometimes we are quite busy so yading10: especially for large patches this can take several weeks. yading10: yading10: If you feel that the review process is too slow and you are willing to try to yading10: take over maintainership of the area of code you change then just clone yading10: git master and maintain the area of code there. We will merge each area from yading10: where its best maintained. yading10: yading10: When resubmitting patches, please do not make any significant changes yading10: not related to the comments received during review. Such patches will yading10: be rejected. Instead, submit significant changes or new features as yading10: separate patches. yading10: yading10: yading10: Regression tests yading10: yading10: Before submitting a patch (or committing to the repository), you should at least yading10: test that you did not break anything. yading10: yading10: Running 'make fate' accomplishes this, please see fate.html for details. yading10: yading10: [Of course, some patches may change the results of the regression tests. In yading10: this case, the reference results of the regression tests shall be modified yading10: accordingly]. yading10: yading10: Adding files to the fate-suite dataset yading10: yading10: When there is no muxer or encoder available to generate test media for a yading10: specific test then the media has to be inlcuded in the fate-suite. yading10: First please make sure that the sample file is as small as possible to test the yading10: respective decoder or demuxer sufficiently. Large files increase network yading10: bandwidth and disk space requirements. yading10: Once you have a working fate test and fate sample, provide in the commit yading10: message or introductionary message for the patch series that you post to yading10: the ffmpeg-devel mailing list, a direct link to download the sample media. yading10: yading10: yading10: Visualizing Test Coverage yading10: yading10: The FFmpeg build system allows visualizing the test coverage in an easy yading10: manner with the coverage tools gcov/lcov.  This involves yading10: the following steps: yading10: yading10: yading10: yading10:     Configure to compile with instrumentation enabled: yading10:     configure --toolchain=gcov. yading10: yading10:     Run your test case, either manually or via FATE. This can be either yading10:     the full FATE regression suite, or any arbitrary invocation of any yading10:     front-end tool provided by FFmpeg, in any combination. yading10: yading10:     Run make lcov to generate coverage data in HTML format. yading10: yading10:     View lcov/index.html in your preferred HTML viewer. yading10: enumerate yading10: yading10: You can use the command make lcov-reset to reset the coverage yading10: measurements. You will need to rerun make lcov after running a yading10: new test. yading10: yading10: yading10: Release process yading10: yading10: FFmpeg maintains a set of release branches, which are the yading10: recommended deliverable for system integrators and distributors (such as yading10: Linux distributions, etc.). At regular times, a release yading10: manager prepares, tests and publishes tarballs on the yading10: http://ffmpeg.org website. yading10: yading10: There are two kinds of releases: yading10: yading10: yading10: yading10:     Major releases always include the latest and greatest yading10:     features and functionality. yading10: yading10:     Point releases are cut from release branches, yading10:     which are named release/X, with X being the release yading10:     version number. yading10: enumerate yading10: yading10: Note that we promise to our users that shared libraries from any FFmpeg yading10: release never break programs that have been compiled against yading10: previous versions of the same release series in any case! yading10: yading10: However, from time to time, we do make API changes that require adaptations yading10: in applications. Such changes are only allowed in (new) major releases and yading10: require further steps such as bumping library version numbers and/or yading10: adjustments to the symbol versioning file. Please discuss such changes yading10: on the ffmpeg-devel mailing list in time to allow forward planning. yading10: yading10: yading10: Criteria for Point Releases yading10: yading10: Changes that match the following criteria are valid candidates for yading10: inclusion into a point release: yading10: yading10: yading10: yading10:     Fixes a security issue, preferably identified by a CVE yading10:     number issued by http://cve.mitre.org/. yading10: yading10:     Fixes a documented bug in https://ffmpeg.org/trac/ffmpeg. yading10: yading10:     Improves the included documentation. yading10: yading10:     Retains both source code and binary compatibility with previous yading10:     point releases of the same release branch. yading10: enumerate yading10: yading10: The order for checking the rules is (1 OR 2 OR 3) AND 4. yading10: yading10: yading10: Release Checklist yading10: yading10: The release process involves the following steps: yading10: yading10: yading10: yading10:     Ensure that the RELEASE file contains the version number for yading10:     the upcoming release. yading10: yading10:     Add the release at https://ffmpeg.org/trac/ffmpeg/admin/ticket/versions. yading10: yading10:     Announce the intent to do a release to the mailing list. yading10: yading10:     Make sure all relevant security fixes have been backported. See yading10:     https://ffmpeg.org/security.html. yading10: yading10:     Ensure that the FATE regression suite still passes in the release yading10:     branch on at least i386 and amd64 yading10:     (cf. Regression tests). yading10: yading10:     Prepare the release tarballs in bz2 and gz formats, and yading10:     supplementing files that contain gpg signatures yading10: yading10:     Publish the tarballs at http://ffmpeg.org/releases. Create and yading10:     push an annotated tag in the form nX, with X yading10:     containing the version number. yading10: yading10:     Propose and send a patch to the ffmpeg-devel mailing list yading10:     with a news entry for the website. yading10: yading10:     Publish the news entry. yading10: yading10:     Send announcement to the mailing list. yading10: enumerate yading10: yading10: