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