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