avformat/hls: Fix DoS due to infinite loop
[ffmpeg.git] / doc / developer.texi
1 \input texinfo @c -*- texinfo -*-
2 @documentencoding UTF-8
3
4 @settitle Developer Documentation
5 @titlepage
6 @center @titlefont{Developer Documentation}
7 @end titlepage
8
9 @top
10
11 @contents
12
13 @chapter Developers Guide
14
15 @section Notes for external developers
16
17 This document is mostly useful for internal FFmpeg developers.
18 External developers who need to use the API in their application should
19 refer to the API doxygen documentation in the public headers, and
20 check the examples in @file{doc/examples} and in the source code to
21 see how the public API is employed.
22
23 You can use the FFmpeg libraries in your commercial program, but you
24 are encouraged to @emph{publish any patch you make}. In this case the
25 best way to proceed is to send your patches to the ffmpeg-devel
26 mailing list following the guidelines illustrated in the remainder of
27 this document.
28
29 For more detailed legal information about the use of FFmpeg in
30 external programs read the @file{LICENSE} file in the source tree and
31 consult @url{https://ffmpeg.org/legal.html}.
32
33 @section Contributing
34
35 There are 3 ways by which code gets into FFmpeg.
36 @itemize @bullet
37 @item Submitting patches to the main developer mailing list.
38       See @ref{Submitting patches} for details.
39 @item Directly committing changes to the main tree.
40 @item Committing changes to a git clone, for example on github.com or
41       gitorious.org. And asking us to merge these changes.
42 @end itemize
43
44 Whichever way, changes should be reviewed by the maintainer of the code
45 before they are committed. And they should follow the @ref{Coding Rules}.
46 The developer making the commit and the author are responsible for their changes
47 and should try to fix issues their commit causes.
48
49 @anchor{Coding Rules}
50 @section Coding Rules
51
52 @subsection Code formatting conventions
53
54 There are the following guidelines regarding the indentation in files:
55
56 @itemize @bullet
57 @item
58 Indent size is 4.
59
60 @item
61 The TAB character is forbidden outside of Makefiles as is any
62 form of trailing whitespace. Commits containing either will be
63 rejected by the git repository.
64
65 @item
66 You should try to limit your code lines to 80 characters; however, do so if
67 and only if this improves readability.
68
69 @item
70 K&R coding style is used.
71 @end itemize
72 The presentation is one inspired by 'indent -i4 -kr -nut'.
73
74 The main priority in FFmpeg is simplicity and small code size in order to
75 minimize the bug count.
76
77 @subsection Comments
78 Use the JavaDoc/Doxygen  format (see examples below) so that code documentation
79 can be generated automatically. All nontrivial functions should have a comment
80 above them explaining what the function does, even if it is just one sentence.
81 All structures and their member variables should be documented, too.
82
83 Avoid Qt-style and similar Doxygen syntax with @code{!} in it, i.e. replace
84 @code{//!} with @code{///} and similar.  Also @@ syntax should be employed
85 for markup commands, i.e. use @code{@@param} and not @code{\param}.
86
87 @example
88 /**
89  * @@file
90  * MPEG codec.
91  * @@author ...
92  */
93
94 /**
95  * Summary sentence.
96  * more text ...
97  * ...
98  */
99 typedef struct Foobar @{
100     int var1; /**< var1 description */
101     int var2; ///< var2 description
102     /** var3 description */
103     int var3;
104 @} Foobar;
105
106 /**
107  * Summary sentence.
108  * more text ...
109  * ...
110  * @@param my_parameter description of my_parameter
111  * @@return return value description
112  */
113 int myfunc(int my_parameter)
114 ...
115 @end example
116
117 @subsection C language features
118
119 FFmpeg is programmed in the ISO C90 language with a few additional
120 features from ISO C99, namely:
121
122 @itemize @bullet
123 @item
124 the @samp{inline} keyword;
125
126 @item
127 @samp{//} comments;
128
129 @item
130 designated struct initializers (@samp{struct s x = @{ .i = 17 @};});
131
132 @item
133 compound literals (@samp{x = (struct s) @{ 17, 23 @};}).
134
135 @item
136 Implementation defined behavior for signed integers is assumed to match the
137 expected behavior for two's complement. Non representable values in integer
138 casts are binary truncated. Shift right of signed values uses sign extension.
139 @end itemize
140
141 These features are supported by all compilers we care about, so we will not
142 accept patches to remove their use unless they absolutely do not impair
143 clarity and performance.
144
145 All code must compile with recent versions of GCC and a number of other
146 currently supported compilers. To ensure compatibility, please do not use
147 additional C99 features or GCC extensions. Especially watch out for:
148
149 @itemize @bullet
150 @item
151 mixing statements and declarations;
152
153 @item
154 @samp{long long} (use @samp{int64_t} instead);
155
156 @item
157 @samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar;
158
159 @item
160 GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
161 @end itemize
162
163 @subsection Naming conventions
164 All names should be composed with underscores (_), not CamelCase. For example,
165 @samp{avfilter_get_video_buffer} is an acceptable function name and
166 @samp{AVFilterGetVideo} is not. The exception from this are type names, like
167 for example structs and enums; they should always be in CamelCase.
168
169 There are the following conventions for naming variables and functions:
170
171 @itemize @bullet
172 @item
173 For local variables no prefix is required.
174
175 @item
176 For file-scope variables and functions declared as @code{static}, no prefix
177 is required.
178
179 @item
180 For variables and functions visible outside of file scope, but only used
181 internally by a library, an @code{ff_} prefix should be used,
182 e.g. @samp{ff_w64_demuxer}.
183
184 @item
185 For variables and functions visible outside of file scope, used internally
186 across multiple libraries, use @code{avpriv_} as prefix, for example,
187 @samp{avpriv_aac_parse_header}.
188
189 @item
190 Each library has its own prefix for public symbols, in addition to the
191 commonly used @code{av_} (@code{avformat_} for libavformat,
192 @code{avcodec_} for libavcodec, @code{swr_} for libswresample, etc).
193 Check the existing code and choose names accordingly.
194 Note that some symbols without these prefixes are also exported for
195 retro-compatibility reasons. These exceptions are declared in the
196 @code{lib<name>/lib<name>.v} files.
197 @end itemize
198
199 Furthermore, name space reserved for the system should not be invaded.
200 Identifiers ending in @code{_t} are reserved by
201 @url{http://pubs.opengroup.org/onlinepubs/007904975/functions/xsh_chap02_02.html#tag_02_02_02, POSIX}.
202 Also avoid names starting with @code{__} or @code{_} followed by an uppercase
203 letter as they are reserved by the C standard. Names starting with @code{_}
204 are reserved at the file level and may not be used for externally visible
205 symbols. If in doubt, just avoid names starting with @code{_} altogether.
206
207 @subsection Miscellaneous conventions
208
209 @itemize @bullet
210 @item
211 fprintf and printf are forbidden in libavformat and libavcodec,
212 please use av_log() instead.
213
214 @item
215 Casts should be used only when necessary. Unneeded parentheses
216 should also be avoided if they don't make the code easier to understand.
217 @end itemize
218
219 @subsection Editor configuration
220 In order to configure Vim to follow FFmpeg formatting conventions, paste
221 the following snippet into your @file{.vimrc}:
222 @example
223 " indentation rules for FFmpeg: 4 spaces, no tabs
224 set expandtab
225 set shiftwidth=4
226 set softtabstop=4
227 set cindent
228 set cinoptions=(0
229 " Allow tabs in Makefiles.
230 autocmd FileType make,automake set noexpandtab shiftwidth=8 softtabstop=8
231 " Trailing whitespace and tabs are forbidden, so highlight them.
232 highlight ForbiddenWhitespace ctermbg=red guibg=red
233 match ForbiddenWhitespace /\s\+$\|\t/
234 " Do not highlight spaces at the end of line while typing on that line.
235 autocmd InsertEnter * match ForbiddenWhitespace /\t\|\s\+\%#\@@<!$/
236 @end example
237
238 For Emacs, add these roughly equivalent lines to your @file{.emacs.d/init.el}:
239 @lisp
240 (c-add-style "ffmpeg"
241              '("k&r"
242                (c-basic-offset . 4)
243                (indent-tabs-mode . nil)
244                (show-trailing-whitespace . t)
245                (c-offsets-alist
246                 (statement-cont . (c-lineup-assignments +)))
247                )
248              )
249 (setq c-default-style "ffmpeg")
250 @end lisp
251
252 @section Development Policy
253
254 @enumerate
255 @item
256 Contributions should be licensed under the
257 @uref{http://www.gnu.org/licenses/lgpl-2.1.html, LGPL 2.1},
258 including an "or any later version" clause, or, if you prefer
259 a gift-style license, the
260 @uref{http://opensource.org/licenses/isc-license.txt, ISC} or
261 @uref{http://mit-license.org/, MIT} license.
262 @uref{http://www.gnu.org/licenses/gpl-2.0.html, GPL 2} including
263 an "or any later version" clause is also acceptable, but LGPL is
264 preferred.
265 If you add a new file, give it a proper license header. Do not copy and
266 paste it from a random place, use an existing file as template.
267
268 @item
269 You must not commit code which breaks FFmpeg! (Meaning unfinished but
270 enabled code which breaks compilation or compiles but does not work or
271 breaks the regression tests)
272 You can commit unfinished stuff (for testing etc), but it must be disabled
273 (#ifdef etc) by default so it does not interfere with other developers'
274 work.
275
276 @item
277 The commit message should have a short first line in the form of
278 a @samp{topic: short description} as a header, separated by a newline
279 from the body consisting of an explanation of why the change is necessary.
280 If the commit fixes a known bug on the bug tracker, the commit message
281 should include its bug ID. Referring to the issue on the bug tracker does
282 not exempt you from writing an excerpt of the bug in the commit message.
283
284 @item
285 You do not have to over-test things. If it works for you, and you think it
286 should work for others, then commit. If your code has problems
287 (portability, triggers compiler bugs, unusual environment etc) they will be
288 reported and eventually fixed.
289
290 @item
291 Do not commit unrelated changes together, split them into self-contained
292 pieces. Also do not forget that if part B depends on part A, but A does not
293 depend on B, then A can and should be committed first and separate from B.
294 Keeping changes well split into self-contained parts makes reviewing and
295 understanding them on the commit log mailing list easier. This also helps
296 in case of debugging later on.
297 Also if you have doubts about splitting or not splitting, do not hesitate to
298 ask/discuss it on the developer mailing list.
299
300 @item
301 Do not change behavior of the programs (renaming options etc) or public
302 API or ABI without first discussing it on the ffmpeg-devel mailing list.
303 Do not remove functionality from the code. Just improve!
304
305 Note: Redundant code can be removed.
306
307 @item
308 Do not commit changes to the build system (Makefiles, configure script)
309 which change behavior, defaults etc, without asking first. The same
310 applies to compiler warning fixes, trivial looking fixes and to code
311 maintained by other developers. We usually have a reason for doing things
312 the way we do. Send your changes as patches to the ffmpeg-devel mailing
313 list, and if the code maintainers say OK, you may commit. This does not
314 apply to files you wrote and/or maintain.
315
316 @item
317 We refuse source indentation and other cosmetic changes if they are mixed
318 with functional changes, such commits will be rejected and removed. Every
319 developer has his own indentation style, you should not change it. Of course
320 if you (re)write something, you can use your own style, even though we would
321 prefer if the indentation throughout FFmpeg was consistent (Many projects
322 force a given indentation style - we do not.). If you really need to make
323 indentation changes (try to avoid this), separate them strictly from real
324 changes.
325
326 NOTE: If you had to put if()@{ .. @} over a large (> 5 lines) chunk of code,
327 then either do NOT change the indentation of the inner part within (do not
328 move it to the right)! or do so in a separate commit
329
330 @item
331 Always fill out the commit log message. Describe in a few lines what you
332 changed and why. You can refer to mailing list postings if you fix a
333 particular bug. Comments such as "fixed!" or "Changed it." are unacceptable.
334 Recommended format:
335
336 @example
337 area changed: Short 1 line description
338
339 details describing what and why and giving references.
340 @end example
341
342 @item
343 Make sure the author of the commit is set correctly. (see git commit --author)
344 If you apply a patch, send an
345 answer to ffmpeg-devel (or wherever you got the patch from) saying that
346 you applied the patch.
347
348 @item
349 When applying patches that have been discussed (at length) on the mailing
350 list, reference the thread in the log message.
351
352 @item
353 Do NOT commit to code actively maintained by others without permission.
354 Send a patch to ffmpeg-devel instead. If no one answers within a reasonable
355 timeframe (12h for build failures and security fixes, 3 days small changes,
356 1 week for big patches) then commit your patch if you think it is OK.
357 Also note, the maintainer can simply ask for more time to review!
358
359 @item
360 Subscribe to the ffmpeg-cvslog mailing list. The diffs of all commits
361 are sent there and reviewed by all the other developers. Bugs and possible
362 improvements or general questions regarding commits are discussed there. We
363 expect you to react if problems with your code are uncovered.
364
365 @item
366 Update the documentation if you change behavior or add features. If you are
367 unsure how best to do this, send a patch to ffmpeg-devel, the documentation
368 maintainer(s) will review and commit your stuff.
369
370 @item
371 Try to keep important discussions and requests (also) on the public
372 developer mailing list, so that all developers can benefit from them.
373
374 @item
375 Never write to unallocated memory, never write over the end of arrays,
376 always check values read from some untrusted source before using them
377 as array index or other risky things.
378
379 @item
380 Remember to check if you need to bump versions for the specific libav*
381 parts (libavutil, libavcodec, libavformat) you are changing. You need
382 to change the version integer.
383 Incrementing the first component means no backward compatibility to
384 previous versions (e.g. removal of a function from the public API).
385 Incrementing the second component means backward compatible change
386 (e.g. addition of a function to the public API or extension of an
387 existing data structure).
388 Incrementing the third component means a noteworthy binary compatible
389 change (e.g. encoder bug fix that matters for the decoder). The third
390 component always starts at 100 to distinguish FFmpeg from Libav.
391
392 @item
393 Compiler warnings indicate potential bugs or code with bad style. If a type of
394 warning always points to correct and clean code, that warning should
395 be disabled, not the code changed.
396 Thus the remaining warnings can either be bugs or correct code.
397 If it is a bug, the bug has to be fixed. If it is not, the code should
398 be changed to not generate a warning unless that causes a slowdown
399 or obfuscates the code.
400
401 @item
402 Make sure that no parts of the codebase that you maintain are missing from the
403 @file{MAINTAINERS} file. If something that you want to maintain is missing add it with
404 your name after it.
405 If at some point you no longer want to maintain some code, then please help in
406 finding a new maintainer and also don't forget to update the @file{MAINTAINERS} file.
407 @end enumerate
408
409 We think our rules are not too hard. If you have comments, contact us.
410
411 @section Code of conduct
412
413 Be friendly and respectful towards others and third parties.
414 Treat others the way you yourself want to be treated.
415
416 Be considerate. Not everyone shares the same viewpoint and priorities as you do.
417 Different opinions and interpretations help the project.
418 Looking at issues from a different perspective assists development.
419
420 Do not assume malice for things that can be attributed to incompetence. Even if
421 it is malice, it's rarely good to start with that as initial assumption.
422
423 Stay friendly even if someone acts contrarily. Everyone has a bad day
424 once in a while.
425 If you yourself have a bad day or are angry then try to take a break and reply
426 once you are calm and without anger if you have to.
427
428 Try to help other team members and cooperate if you can.
429
430 The goal of software development is to create technical excellence, not for any
431 individual to be better and "win" against the others. Large software projects
432 are only possible and successful through teamwork.
433
434 If someone struggles do not put them down. Give them a helping hand
435 instead and point them in the right direction.
436
437 Finally, keep in mind the immortal words of Bill and Ted,
438 "Be excellent to each other."
439
440 @anchor{Submitting patches}
441 @section Submitting patches
442
443 First, read the @ref{Coding Rules} above if you did not yet, in particular
444 the rules regarding patch submission.
445
446 When you submit your patch, please use @code{git format-patch} or
447 @code{git send-email}. We cannot read other diffs :-).
448
449 Also please do not submit a patch which contains several unrelated changes.
450 Split it into separate, self-contained pieces. This does not mean splitting
451 file by file. Instead, make the patch as small as possible while still
452 keeping it as a logical unit that contains an individual change, even
453 if it spans multiple files. This makes reviewing your patches much easier
454 for us and greatly increases your chances of getting your patch applied.
455
456 Use the patcheck tool of FFmpeg to check your patch.
457 The tool is located in the tools directory.
458
459 Run the @ref{Regression tests} before submitting a patch in order to verify
460 it does not cause unexpected problems.
461
462 It also helps quite a bit if you tell us what the patch does (for example
463 'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant
464 and has no lrint()')
465
466 Also please if you send several patches, send each patch as a separate mail,
467 do not attach several unrelated patches to the same mail.
468
469 Patches should be posted to the
470 @uref{https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-devel, ffmpeg-devel}
471 mailing list. Use @code{git send-email} when possible since it will properly
472 send patches without requiring extra care. If you cannot, then send patches
473 as base64-encoded attachments, so your patch is not trashed during
474 transmission.
475
476 Your patch will be reviewed on the mailing list. You will likely be asked
477 to make some changes and are expected to send in an improved version that
478 incorporates the requests from the review. This process may go through
479 several iterations. Once your patch is deemed good enough, some developer
480 will pick it up and commit it to the official FFmpeg tree.
481
482 Give us a few days to react. But if some time passes without reaction,
483 send a reminder by email. Your patch should eventually be dealt with.
484
485
486 @section New codecs or formats checklist
487
488 @enumerate
489 @item
490 Did you use av_cold for codec initialization and close functions?
491
492 @item
493 Did you add a long_name under NULL_IF_CONFIG_SMALL to the AVCodec or
494 AVInputFormat/AVOutputFormat struct?
495
496 @item
497 Did you bump the minor version number (and reset the micro version
498 number) in @file{libavcodec/version.h} or @file{libavformat/version.h}?
499
500 @item
501 Did you register it in @file{allcodecs.c} or @file{allformats.c}?
502
503 @item
504 Did you add the AVCodecID to @file{avcodec.h}?
505 When adding new codec IDs, also add an entry to the codec descriptor
506 list in @file{libavcodec/codec_desc.c}.
507
508 @item
509 If it has a FourCC, did you add it to @file{libavformat/riff.c},
510 even if it is only a decoder?
511
512 @item
513 Did you add a rule to compile the appropriate files in the Makefile?
514 Remember to do this even if you're just adding a format to a file that is
515 already being compiled by some other rule, like a raw demuxer.
516
517 @item
518 Did you add an entry to the table of supported formats or codecs in
519 @file{doc/general.texi}?
520
521 @item
522 Did you add an entry in the Changelog?
523
524 @item
525 If it depends on a parser or a library, did you add that dependency in
526 configure?
527
528 @item
529 Did you @code{git add} the appropriate files before committing?
530
531 @item
532 Did you make sure it compiles standalone, i.e. with
533 @code{configure --disable-everything --enable-decoder=foo}
534 (or @code{--enable-demuxer} or whatever your component is)?
535 @end enumerate
536
537
538 @section patch submission checklist
539
540 @enumerate
541 @item
542 Does @code{make fate} pass with the patch applied?
543
544 @item
545 Was the patch generated with git format-patch or send-email?
546
547 @item
548 Did you sign off your patch? (git commit -s)
549 See @url{http://git.kernel.org/?p=linux/kernel/git/torvalds/linux.git;a=blob_plain;f=Documentation/SubmittingPatches} for the meaning
550 of sign off.
551
552 @item
553 Did you provide a clear git commit log message?
554
555 @item
556 Is the patch against latest FFmpeg git master branch?
557
558 @item
559 Are you subscribed to ffmpeg-devel?
560 (the list is subscribers only due to spam)
561
562 @item
563 Have you checked that the changes are minimal, so that the same cannot be
564 achieved with a smaller patch and/or simpler final code?
565
566 @item
567 If the change is to speed critical code, did you benchmark it?
568
569 @item
570 If you did any benchmarks, did you provide them in the mail?
571
572 @item
573 Have you checked that the patch does not introduce buffer overflows or
574 other security issues?
575
576 @item
577 Did you test your decoder or demuxer against damaged data? If no, see
578 tools/trasher, the noise bitstream filter, and
579 @uref{http://caca.zoy.org/wiki/zzuf, zzuf}. Your decoder or demuxer
580 should not crash, end in a (near) infinite loop, or allocate ridiculous
581 amounts of memory when fed damaged data.
582
583 @item
584 Did you test your decoder or demuxer against sample files?
585 Samples may be obtained at @url{https://samples.ffmpeg.org}.
586
587 @item
588 Does the patch not mix functional and cosmetic changes?
589
590 @item
591 Did you add tabs or trailing whitespace to the code? Both are forbidden.
592
593 @item
594 Is the patch attached to the email you send?
595
596 @item
597 Is the mime type of the patch correct? It should be text/x-diff or
598 text/x-patch or at least text/plain and not application/octet-stream.
599
600 @item
601 If the patch fixes a bug, did you provide a verbose analysis of the bug?
602
603 @item
604 If the patch fixes a bug, did you provide enough information, including
605 a sample, so the bug can be reproduced and the fix can be verified?
606 Note please do not attach samples >100k to mails but rather provide a
607 URL, you can upload to ftp://upload.ffmpeg.org.
608
609 @item
610 Did you provide a verbose summary about what the patch does change?
611
612 @item
613 Did you provide a verbose explanation why it changes things like it does?
614
615 @item
616 Did you provide a verbose summary of the user visible advantages and
617 disadvantages if the patch is applied?
618
619 @item
620 Did you provide an example so we can verify the new feature added by the
621 patch easily?
622
623 @item
624 If you added a new file, did you insert a license header? It should be
625 taken from FFmpeg, not randomly copied and pasted from somewhere else.
626
627 @item
628 You should maintain alphabetical order in alphabetically ordered lists as
629 long as doing so does not break API/ABI compatibility.
630
631 @item
632 Lines with similar content should be aligned vertically when doing so
633 improves readability.
634
635 @item
636 Consider adding a regression test for your code.
637
638 @item
639 If you added YASM code please check that things still work with --disable-yasm.
640
641 @item
642 Make sure you check the return values of function and return appropriate
643 error codes. Especially memory allocation functions like @code{av_malloc()}
644 are notoriously left unchecked, which is a serious problem.
645
646 @item
647 Test your code with valgrind and or Address Sanitizer to ensure it's free
648 of leaks, out of array accesses, etc.
649 @end enumerate
650
651 @section Patch review process
652
653 All patches posted to ffmpeg-devel will be reviewed, unless they contain a
654 clear note that the patch is not for the git master branch.
655 Reviews and comments will be posted as replies to the patch on the
656 mailing list. The patch submitter then has to take care of every comment,
657 that can be by resubmitting a changed patch or by discussion. Resubmitted
658 patches will themselves be reviewed like any other patch. If at some point
659 a patch passes review with no comments then it is approved, that can for
660 simple and small patches happen immediately while large patches will generally
661 have to be changed and reviewed many times before they are approved.
662 After a patch is approved it will be committed to the repository.
663
664 We will review all submitted patches, but sometimes we are quite busy so
665 especially for large patches this can take several weeks.
666
667 If you feel that the review process is too slow and you are willing to try to
668 take over maintainership of the area of code you change then just clone
669 git master and maintain the area of code there. We will merge each area from
670 where its best maintained.
671
672 When resubmitting patches, please do not make any significant changes
673 not related to the comments received during review. Such patches will
674 be rejected. Instead, submit significant changes or new features as
675 separate patches.
676
677 Everyone is welcome to review patches. Also if you are waiting for your patch
678 to be reviewed, please consider helping to review other patches, that is a great
679 way to get everyone's patches reviewed sooner.
680
681 @anchor{Regression tests}
682 @section Regression tests
683
684 Before submitting a patch (or committing to the repository), you should at least
685 test that you did not break anything.
686
687 Running 'make fate' accomplishes this, please see @url{fate.html} for details.
688
689 [Of course, some patches may change the results of the regression tests. In
690 this case, the reference results of the regression tests shall be modified
691 accordingly].
692
693 @subsection Adding files to the fate-suite dataset
694
695 When there is no muxer or encoder available to generate test media for a
696 specific test then the media has to be included in the fate-suite.
697 First please make sure that the sample file is as small as possible to test the
698 respective decoder or demuxer sufficiently. Large files increase network
699 bandwidth and disk space requirements.
700 Once you have a working fate test and fate sample, provide in the commit
701 message or introductory message for the patch series that you post to
702 the ffmpeg-devel mailing list, a direct link to download the sample media.
703
704 @subsection Visualizing Test Coverage
705
706 The FFmpeg build system allows visualizing the test coverage in an easy
707 manner with the coverage tools @code{gcov}/@code{lcov}.  This involves
708 the following steps:
709
710 @enumerate
711 @item
712     Configure to compile with instrumentation enabled:
713     @code{configure --toolchain=gcov}.
714
715 @item
716     Run your test case, either manually or via FATE. This can be either
717     the full FATE regression suite, or any arbitrary invocation of any
718     front-end tool provided by FFmpeg, in any combination.
719
720 @item
721     Run @code{make lcov} to generate coverage data in HTML format.
722
723 @item
724     View @code{lcov/index.html} in your preferred HTML viewer.
725 @end enumerate
726
727 You can use the command @code{make lcov-reset} to reset the coverage
728 measurements. You will need to rerun @code{make lcov} after running a
729 new test.
730
731 @subsection Using Valgrind
732
733 The configure script provides a shortcut for using valgrind to spot bugs
734 related to memory handling. Just add the option
735 @code{--toolchain=valgrind-memcheck} or @code{--toolchain=valgrind-massif}
736 to your configure line, and reasonable defaults will be set for running
737 FATE under the supervision of either the @strong{memcheck} or the
738 @strong{massif} tool of the valgrind suite.
739
740 In case you need finer control over how valgrind is invoked, use the
741 @code{--target-exec='valgrind <your_custom_valgrind_options>} option in
742 your configure line instead.
743
744 @anchor{Release process}
745 @section Release process
746
747 FFmpeg maintains a set of @strong{release branches}, which are the
748 recommended deliverable for system integrators and distributors (such as
749 Linux distributions, etc.). At regular times, a @strong{release
750 manager} prepares, tests and publishes tarballs on the
751 @url{https://ffmpeg.org} website.
752
753 There are two kinds of releases:
754
755 @enumerate
756 @item
757 @strong{Major releases} always include the latest and greatest
758 features and functionality.
759
760 @item
761 @strong{Point releases} are cut from @strong{release} branches,
762 which are named @code{release/X}, with @code{X} being the release
763 version number.
764 @end enumerate
765
766 Note that we promise to our users that shared libraries from any FFmpeg
767 release never break programs that have been @strong{compiled} against
768 previous versions of @strong{the same release series} in any case!
769
770 However, from time to time, we do make API changes that require adaptations
771 in applications. Such changes are only allowed in (new) major releases and
772 require further steps such as bumping library version numbers and/or
773 adjustments to the symbol versioning file. Please discuss such changes
774 on the @strong{ffmpeg-devel} mailing list in time to allow forward planning.
775
776 @anchor{Criteria for Point Releases}
777 @subsection Criteria for Point Releases
778
779 Changes that match the following criteria are valid candidates for
780 inclusion into a point release:
781
782 @enumerate
783 @item
784 Fixes a security issue, preferably identified by a @strong{CVE
785 number} issued by @url{http://cve.mitre.org/}.
786
787 @item
788 Fixes a documented bug in @url{https://trac.ffmpeg.org}.
789
790 @item
791 Improves the included documentation.
792
793 @item
794 Retains both source code and binary compatibility with previous
795 point releases of the same release branch.
796 @end enumerate
797
798 The order for checking the rules is (1 OR 2 OR 3) AND 4.
799
800
801 @subsection Release Checklist
802
803 The release process involves the following steps:
804
805 @enumerate
806 @item
807 Ensure that the @file{RELEASE} file contains the version number for
808 the upcoming release.
809
810 @item
811 Add the release at @url{https://trac.ffmpeg.org/admin/ticket/versions}.
812
813 @item
814 Announce the intent to do a release to the mailing list.
815
816 @item
817 Make sure all relevant security fixes have been backported. See
818 @url{https://ffmpeg.org/security.html}.
819
820 @item
821 Ensure that the FATE regression suite still passes in the release
822 branch on at least @strong{i386} and @strong{amd64}
823 (cf. @ref{Regression tests}).
824
825 @item
826 Prepare the release tarballs in @code{bz2} and @code{gz} formats, and
827 supplementing files that contain @code{gpg} signatures
828
829 @item
830 Publish the tarballs at @url{https://ffmpeg.org/releases}. Create and
831 push an annotated tag in the form @code{nX}, with @code{X}
832 containing the version number.
833
834 @item
835 Propose and send a patch to the @strong{ffmpeg-devel} mailing list
836 with a news entry for the website.
837
838 @item
839 Publish the news entry.
840
841 @item
842 Send an announcement to the mailing list.
843 @end enumerate
844
845 @bye