developer.texi 27.5 KB
Newer Older
1 2 3 4 5 6 7
\input texinfo @c -*- texinfo -*-

@settitle Developer Documentation
@titlepage
@center @titlefont{Developer Documentation}
@end titlepage

8 9 10
@top

@contents
11 12 13

@chapter Developers Guide

14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
@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}.
31

32 33 34 35
@section Contributing

There are 3 ways by which code gets into ffmpeg.
@itemize @bullet
36
@item Submitting Patches to the main developer mailing list
37
      see @ref{Submitting patches} for details.
38 39
@item Directly committing changes to the main tree.
@item Committing changes to a git clone, for example on github.com or
40 41 42 43
      gitorious.org. And asking us to merge these changes.
@end itemize

Whichever way, changes should be reviewed by the maintainer of the code
44
before they are committed. And they should follow the @ref{Coding Rules}.
45 46
The developer making the commit and the author are responsible for their changes
and should try to fix issues their commit causes.
47

48
@anchor{Coding Rules}
49 50
@section Coding Rules

51
@subsection Code formatting conventions
52

53
There are the following guidelines regarding the indentation in files:
54

55 56 57
@itemize @bullet
@item
Indent size is 4.
58

59
@item
60 61
The TAB character is forbidden outside of Makefiles as is any
form of trailing whitespace. Commits containing either will be
62
rejected by the git repository.
63

64
@item
65 66
You should try to limit your code lines to 80 characters; however, do so if
and only if this improves readability.
67 68
@end itemize
The presentation is one inspired by 'indent -i4 -kr -nut'.
69

70
The main priority in FFmpeg is simplicity and small code size in order to
71 72
minimize the bug count.

73 74
@subsection Comments
Use the JavaDoc/Doxygen  format (see examples below) so that code documentation
75 76 77
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.
78 79 80 81 82

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}.

83 84
@example
/**
85
 * @@file
86 87 88 89 90 91 92 93 94
 * MPEG codec.
 * @@author ...
 */

/**
 * Summary sentence.
 * more text ...
 * ...
 */
95
typedef struct Foobar @{
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
    int var1; /**< var1 description */
    int var2; ///< var2 description
    /** var3 description */
    int var3;
@} Foobar;

/**
 * Summary sentence.
 * more text ...
 * ...
 * @@param my_parameter description of my_parameter
 * @@return return value description
 */
int myfunc(int my_parameter)
...
@end example

113 114
@subsection C language features

115
FFmpeg is programmed in the ISO C90 language with a few additional
116
features from ISO C99, namely:
117

118 119 120
@itemize @bullet
@item
the @samp{inline} keyword;
121

122 123
@item
@samp{//} comments;
124

125 126
@item
designated struct initializers (@samp{struct s x = @{ .i = 17 @};})
127

128 129 130 131 132 133 134 135 136 137 138
@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:
139

140 141 142
@itemize @bullet
@item
mixing statements and declarations;
143

144 145
@item
@samp{long long} (use @samp{int64_t} instead);
146

147 148
@item
@samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar;
149

150 151 152 153 154
@item
GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
@end itemize

@subsection Naming conventions
155 156
All names should be composed with underscores (_), not CamelCase. For example,
@samp{avfilter_get_video_buffer} is an acceptable function name and
157
@samp{AVFilterGetVideo} is not. The exception from this are type names, like
158
for example structs and enums; they should always be in the CamelCase
159

160
There are the following conventions for naming variables and functions:
161

162 163 164
@itemize @bullet
@item
For local variables no prefix is required.
165

166
@item
167 168
For file-scope variables and functions declared as @code{static}, no prefix
is required.
169

170
@item
171 172 173
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}.
174

175
@item
176 177 178
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}.
179

180
@item
181 182 183 184 185 186 187
Each library has its own prefix for public symbols, in addition to the
commonly used @code{av_} (@code{avformat_} for libavformat,
@code{avcodec_} for libavcodec, @code{swr_} for libswresample, etc).
Check the existing code and choose names accordingly.
Note that some symbols without these prefixes are also exported for
retro-compatibility reasons. These exceptions are declared in the
@code{lib<name>/lib<name>.v} files.
188 189
@end itemize

190 191 192 193 194 195 196 197
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.

Diego Biurrun's avatar
Diego Biurrun committed
198
@subsection Miscellaneous conventions
199

200 201
@itemize @bullet
@item
202 203
fprintf and printf are forbidden in libavformat and libavcodec,
please use av_log() instead.
204

205
@item
206 207
Casts should be used only when necessary. Unneeded parentheses
should also be avoided if they don't make the code easier to understand.
208
@end itemize
209

210
@subsection Editor configuration
211
In order to configure Vim to follow FFmpeg formatting conventions, paste
212 213
the following snippet into your @file{.vimrc}:
@example
214
" indentation rules for FFmpeg: 4 spaces, no tabs
215 216 217
set expandtab
set shiftwidth=4
set softtabstop=4
218 219
set cindent
set cinoptions=(0
220
" Allow tabs in Makefiles.
221
autocmd FileType make,automake set noexpandtab shiftwidth=8 softtabstop=8
222 223 224 225 226 227 228 229 230
" 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
231
(c-add-style "ffmpeg"
232 233
             '("k&r"
               (c-basic-offset . 4)
234 235
               (indent-tabs-mode . nil)
               (show-trailing-whitespace . t)
236 237 238 239
               (c-offsets-alist
                (statement-cont . (c-lineup-assignments +)))
               )
             )
240
(setq c-default-style "ffmpeg")
241 242
@end example

243 244 245 246
@section Development Policy

@enumerate
@item
247 248 249 250
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
251
@uref{http://opensource.org/licenses/isc-license.txt, ISC} or
252 253 254 255
@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.
256 257
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.
258 259

@item
260 261 262 263 264 265
You must not commit code which breaks FFmpeg! (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.
266 267 268 269 270 271 272 273 274 275

@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.

@item
276 277 278 279
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.
280 281 282 283 284 285 286 287

@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.
288 289
Also if you have doubts about splitting or not splitting, do not hesitate to
ask/discuss it on the developer mailing list.
290 291

@item
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
Do not change behavior of the programs (renaming options etc) or public
API or ABI without first discussing it on the ffmpeg-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 ffmpeg-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 FFmpeg 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.
Recommended format:
area changed: Short 1 line description

details describing what and why and giving references.

@item
Make sure the author of the commit is set correctly. (see git commit --author)
If you apply a patch, send an
answer to ffmpeg-devel (or wherever you got the patch from) saying that
you applied the patch.
335 336 337 338 339 340

@item
When applying patches that have been discussed (at length) on the mailing
list, reference the thread in the log message.

@item
341 342 343 344 345 346 347 348 349 350 351
Do NOT commit to code actively maintained by others without permission.
Send a patch to ffmpeg-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 ffmpeg-cvslog 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.
352 353 354

@item
Update the documentation if you change behavior or add features. If you are
355 356
unsure how best to do this, send a patch to ffmpeg-devel, the documentation
maintainer(s) will review and commit your stuff.
357 358

@item
359 360
Try to keep important discussions and requests (also) on the public
developer mailing list, so that all developers can benefit from them.
361 362 363 364

@item
Never write to unallocated memory, never write over the end of arrays,
always check values read from some untrusted source before using them
365
as array index or other risky things.
366 367

@item
368
Remember to check if you need to bump versions for the specific libav*
369 370 371 372 373 374 375 376
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
377 378
change (e.g. encoder bug fix that matters for the decoder). The third
component always starts at 100 to distinguish FFmpeg from Libav.
379 380

@item
381 382 383 384
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.
385 386 387 388
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.

389 390 391 392 393 394
@item
Make sure that no parts of the codebase that you maintain are missing from the
@file{MAINTAINERS} file. If something that you want to maintain is missing add it with
your name after it.
If at some point you no longer want to maintain some code, then please help
finding a new maintainer and also don't forget updating the @file{MAINTAINERS} file.
395 396 397 398
@end enumerate

We think our rules are not too hard. If you have comments, contact us.

399
@anchor{Submitting patches}
400 401
@section Submitting patches

402
First, read the @ref{Coding Rules} above if you did not yet, in particular
403
the rules regarding patch submission.
404

405 406
When you submit your patch, please use @code{git format-patch} or
@code{git send-email}. We cannot read other diffs :-)
407 408 409 410 411 412 413 414

Also 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
if it spans multiple files. This makes reviewing your patches much easier
for us and greatly increases your chances of getting your patch applied.

415
Use the patcheck tool of FFmpeg to check your patch.
416
The tool is located in the tools directory.
Zhihang Wang's avatar
Zhihang Wang committed
417

418
Run the @ref{Regression tests} before submitting a patch in order to verify
419
it does not cause unexpected problems.
420 421 422 423 424 425 426 427

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()')

Also please if you send several patches, send each patch as a separate mail,
do not attach several unrelated patches to the same mail.

428
Patches should be posted to the
429
@uref{http://lists.ffmpeg.org/mailman/listinfo/ffmpeg-devel, ffmpeg-devel}
430 431 432 433
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.
434

435 436 437 438
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
439
will pick it up and commit it to the official FFmpeg tree.
440 441 442 443 444

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.


445 446 447 448
@section New codecs or formats checklist

@enumerate
@item
449 450
Did you use av_cold for codec initialization and close functions?

451
@item
452 453 454
Did you add a long_name under NULL_IF_CONFIG_SMALL to the AVCodec or
AVInputFormat/AVOutputFormat struct?

455
@item
456 457 458
Did you bump the minor version number (and reset the micro version
number) in @file{libavcodec/version.h} or @file{libavformat/version.h}?

459
@item
460 461
Did you register it in @file{allcodecs.c} or @file{allformats.c}?

462
@item
463 464 465 466
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}.

467
@item
468 469 470
If it has a FourCC, did you add it to @file{libavformat/riff.c},
even if it is only a decoder?

471
@item
472
Did you add a rule to compile the appropriate files in the Makefile?
473 474
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.
475

476
@item
477 478 479
Did you add an entry to the table of supported formats or codecs in
@file{doc/general.texi}?

480
@item
481 482
Did you add an entry in the Changelog?

483
@item
484 485 486
If it depends on a parser or a library, did you add that dependency in
configure?

487
@item
488 489
Did you @code{git add} the appropriate files before committing?

490
@item
491 492 493
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)?
494 495
@end enumerate

496

497 498 499 500
@section patch submission checklist

@enumerate
@item
501 502
Does @code{make fate} pass with the patch applied?

503
@item
504 505
Was the patch generated with git format-patch or send-email?

506
@item
507 508 509 510
Did you sign off your patch? (git commit -s)
See @url{http://git.kernel.org/?p=linux/kernel/git/torvalds/linux.git;a=blob_plain;f=Documentation/SubmittingPatches} for the meaning
of sign off.

511
@item
512
Did you provide a clear git commit log message?
513

514
@item
515
Is the patch against latest FFmpeg git master branch?
516

517
@item
518 519
Are you subscribed to ffmpeg-devel?
(the list is subscribers only due to spam)
520

521
@item
522 523 524
Have you checked that the changes are minimal, so that the same cannot be
achieved with a smaller patch and/or simpler final code?

525
@item
526 527
If the change is to speed critical code, did you benchmark it?

528
@item
529 530
If you did any benchmarks, did you provide them in the mail?

531
@item
532 533 534
Have you checked that the patch does not introduce buffer overflows or
other security issues?

535
@item
536 537 538 539 540 541
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.

542
@item
543 544
Does the patch not mix functional and cosmetic changes?

545
@item
546 547
Did you add tabs or trailing whitespace to the code? Both are forbidden.

548
@item
549 550
Is the patch attached to the email you send?

551
@item
552 553 554
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.

555
@item
556 557
If the patch fixes a bug, did you provide a verbose analysis of the bug?

558
@item
559 560 561
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
562
URL, you can upload to ftp://upload.ffmpeg.org
563

564
@item
565 566
Did you provide a verbose summary about what the patch does change?

567
@item
568 569
Did you provide a verbose explanation why it changes things like it does?

570
@item
571 572 573
Did you provide a verbose summary of the user visible advantages and
disadvantages if the patch is applied?

574
@item
575 576 577
Did you provide an example so we can verify the new feature added by the
patch easily?

578
@item
579
If you added a new file, did you insert a license header? It should be
580
taken from FFmpeg, not randomly copied and pasted from somewhere else.
581

582
@item
583 584 585
You should maintain alphabetical order in alphabetically ordered lists as
long as doing so does not break API/ABI compatibility.

586
@item
587 588 589
Lines with similar content should be aligned vertically when doing so
improves readability.

590
@item
591 592
Consider to add a regression test for your code.

593
@item
594 595
If you added YASM code please check that things still work with --disable-yasm

596
@item
597
Make sure you check the return values of function and return appropriate
598
error codes. Especially memory allocation functions like @code{av_malloc()}
599
are notoriously left unchecked, which is a serious problem.
600

601
@item
602 603
Test your code with valgrind and or Address Sanitizer to ensure it's free
of leaks, out of array accesses, etc.
604 605 606 607 608
@end enumerate

@section Patch review process

All patches posted to ffmpeg-devel will be reviewed, unless they contain a
609
clear note that the patch is not for the git master branch.
610 611 612 613 614 615 616 617 618 619 620 621
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,
that can be by resubmitting a changed patch or by discussion. Resubmitted
patches will themselves be reviewed like any other patch. If at some point
a patch passes review with no comments then it is approved, that can for
simple and small patches happen immediately while large patches will generally
have to be changed and reviewed many times before they are approved.
After a patch is approved it will be committed to the repository.

We will review all submitted patches, but sometimes we are quite busy so
especially for large patches this can take several weeks.

622 623 624 625 626
If you feel that the review process is too slow and you are willing to try to
take over maintainership of the area of code you change then just clone
git master and maintain the area of code there. We will merge each area from
where its best maintained.

627 628
When resubmitting patches, please do not make any significant changes
not related to the comments received during review. Such patches will
629
be rejected. Instead, submit significant changes or new features as
630 631
separate patches.

632
@anchor{Regression tests}
633 634 635 636 637
@section Regression tests

Before submitting a patch (or committing to the repository), you should at least
test that you did not break anything.

638
Running 'make fate' accomplishes this, please see @url{fate.html} for details.
639 640 641 642 643

[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].

644 645 646 647 648 649 650 651 652 653 654 655
@subsection Adding files to the fate-suite dataset

When there is no muxer or encoder available to generate test media for a
specific test then the media has to be inlcuded in the fate-suite.
First please make sure that the sample file is as small as possible to test the
respective decoder or demuxer sufficiently. Large files increase network
bandwidth and disk space requirements.
Once you have a working fate test and fate sample, provide in the commit
message or introductionary message for the patch series that you post to
the ffmpeg-devel mailing list, a direct link to download the sample media.


656 657
@subsection Visualizing Test Coverage

658
The FFmpeg build system allows visualizing the test coverage in an easy
659 660 661 662 663 664 665
manner with the coverage tools @code{gcov}/@code{lcov}.  This involves
the following steps:

@enumerate
@item
    Configure to compile with instrumentation enabled:
    @code{configure --toolchain=gcov}.
666

667 668 669
@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
670
    front-end tool provided by FFmpeg, in any combination.
671

672 673
@item
    Run @code{make lcov} to generate coverage data in HTML format.
674

675 676 677 678 679 680 681 682
@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.

683 684 685 686
@subsection Using Valgrind

The configure script provides a shortcut for using valgrind to spot bugs
related to memory handling. Just add the option
687 688 689 690
@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.
691 692 693 694 695

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.

696 697 698
@anchor{Release process}
@section Release process

699
FFmpeg maintains a set of @strong{release branches}, which are the
700
recommended deliverable for system integrators and distributors (such as
701
Linux distributions, etc.). At regular times, a @strong{release
702
manager} prepares, tests and publishes tarballs on the
703
@url{http://ffmpeg.org} website.
704 705 706 707 708

There are two kinds of releases:

@enumerate
@item
709 710 711
@strong{Major releases} always include the latest and greatest
features and functionality.

712
@item
713 714 715
@strong{Point releases} are cut from @strong{release} branches,
which are named @code{release/X}, with @code{X} being the release
version number.
716 717
@end enumerate

718
Note that we promise to our users that shared libraries from any FFmpeg
719 720 721 722 723 724 725
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
726
on the @strong{ffmpeg-devel} mailing list in time to allow forward planning.
727 728 729 730 731 732 733 734 735

@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
736 737 738
Fixes a security issue, preferably identified by a @strong{CVE
number} issued by @url{http://cve.mitre.org/}.

739
@item
740
Fixes a documented bug in @url{https://trac.ffmpeg.org}.
741

742
@item
743 744
Improves the included documentation.

745
@item
746 747
Retains both source code and binary compatibility with previous
point releases of the same release branch.
748 749 750 751 752 753 754 755 756 757 758
@end enumerate

The order for checking the rules is (1 OR 2 OR 3) AND 4.


@subsection Release Checklist

The release process involves the following steps:

@enumerate
@item
759 760 761
Ensure that the @file{RELEASE} file contains the version number for
the upcoming release.

762
@item
763
Add the release at @url{https://trac.ffmpeg.org/admin/ticket/versions}.
764

765
@item
766 767
Announce the intent to do a release to the mailing list.

768
@item
769 770
Make sure all relevant security fixes have been backported. See
@url{https://ffmpeg.org/security.html}.
771

772
@item
773 774
Ensure that the FATE regression suite still passes in the release
branch on at least @strong{i386} and @strong{amd64}
775
(cf. @ref{Regression tests}).
776

777
@item
778 779
Prepare the release tarballs in @code{bz2} and @code{gz} formats, and
supplementing files that contain @code{gpg} signatures
780

781
@item
782 783
Publish the tarballs at @url{http://ffmpeg.org/releases}. Create and
push an annotated tag in the form @code{nX}, with @code{X}
784 785
containing the version number.

786
@item
787
Propose and send a patch to the @strong{ffmpeg-devel} mailing list
788 789
with a news entry for the website.

790
@item
791 792
Publish the news entry.

793
@item
794
Send announcement to the mailing list.
795 796
@end enumerate

797
@bye