1 \input texinfo @c -*- texinfo -*-
3 @settitle Developer Documentation
5 @center @titlefont{Developer Documentation}
12 @chapter Developers Guide
14 @section Notes for external developers
16 This document is mostly useful for internal FFmpeg developers.
17 External developers who need to use the API in their application should
18 refer to the API doxygen documentation in the public headers, and
19 check the examples in @file{doc/examples} and in the source code to
20 see how the public API is employed.
22 You can use the FFmpeg libraries in your commercial program, but you
23 are encouraged to @emph{publish any patch you make}. In this case the
24 best way to proceed is to send your patches to the ffmpeg-devel
25 mailing list following the guidelines illustrated in the remainder of
28 For more detailed legal information about the use of FFmpeg in
29 external programs read the @file{LICENSE} file in the source tree and
30 consult @url{http://ffmpeg.org/legal.html}.
34 There are 3 ways by which code gets into ffmpeg.
36 @item Submitting Patches to the main developer mailing list
37 see @ref{Submitting patches} for details.
38 @item Directly committing changes to the main tree.
39 @item Committing changes to a git clone, for example on github.com or
40 gitorious.org. And asking us to merge these changes.
43 Whichever way, changes should be reviewed by the maintainer of the code
44 before they are committed. And they should follow the @ref{Coding Rules}.
45 The developer making the commit and the author are responsible for their changes
46 and should try to fix issues their commit causes.
51 @subsection Code formatting conventions
53 There are the following guidelines regarding the indentation in files:
60 The TAB character is forbidden outside of Makefiles as is any
61 form of trailing whitespace. Commits containing either will be
62 rejected by the git repository.
65 You should try to limit your code lines to 80 characters; however, do so if
66 and only if this improves readability.
68 The presentation is one inspired by 'indent -i4 -kr -nut'.
70 The main priority in FFmpeg is simplicity and small code size in order to
71 minimize the bug count.
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.
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}.
95 typedef struct Foobar@{
96 int var1; /**< var1 description */
97 int var2; ///< var2 description
98 /** var3 description */
106 * @@param my_parameter description of my_parameter
107 * @@return return value description
109 int myfunc(int my_parameter)
113 @subsection C language features
115 FFmpeg is programmed in the ISO C90 language with a few additional
116 features from ISO C99, namely:
120 the @samp{inline} keyword;
126 designated struct initializers (@samp{struct s x = @{ .i = 17 @};})
129 compound literals (@samp{x = (struct s) @{ 17, 23 @};})
132 These features are supported by all compilers we care about, so we will not
133 accept patches to remove their use unless they absolutely do not impair
134 clarity and performance.
136 All code must compile with recent versions of GCC and a number of other
137 currently supported compilers. To ensure compatibility, please do not use
138 additional C99 features or GCC extensions. Especially watch out for:
142 mixing statements and declarations;
145 @samp{long long} (use @samp{int64_t} instead);
148 @samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar;
151 GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
154 @subsection Naming conventions
155 All names should be composed with underscores (_), not CamelCase. For example,
156 @samp{avfilter_get_video_buffer} is an acceptable function name and
157 @samp{AVFilterGetVideo} is not. The exception from this are type names, like
158 for example structs and enums; they should always be in the CamelCase
160 There are the following conventions for naming variables and functions:
164 For local variables no prefix is required.
167 For file-scope variables and functions declared as @code{static}, no prefix
171 For variables and functions visible outside of file scope, but only used
172 internally by a library, an @code{ff_} prefix should be used,
173 e.g. @samp{ff_w64_demuxer}.
176 For variables and functions visible outside of file scope, used internally
177 across multiple libraries, use @code{avpriv_} as prefix, for example,
178 @samp{avpriv_aac_parse_header}.
181 Each library has its own prefix for public symbols, in addition to the
182 commonly used @code{av_} (@code{avformat_} for libavformat,
183 @code{avcodec_} for libavcodec, @code{swr_} for libswresample, etc).
184 Check the existing code and choose names accordingly.
185 Note that some symbols without these prefixes are also exported for
186 retro-compatibility reasons. These exceptions are declared in the
187 @code{lib<name>/lib<name>.v} files.
190 Furthermore, name space reserved for the system should not be invaded.
191 Identifiers ending in @code{_t} are reserved by
192 @url{http://pubs.opengroup.org/onlinepubs/007904975/functions/xsh_chap02_02.html#tag_02_02_02, POSIX}.
193 Also avoid names starting with @code{__} or @code{_} followed by an uppercase
194 letter as they are reserved by the C standard. Names starting with @code{_}
195 are reserved at the file level and may not be used for externally visible
196 symbols. If in doubt, just avoid names starting with @code{_} altogether.
198 @subsection Miscellaneous conventions
202 fprintf and printf are forbidden in libavformat and libavcodec,
203 please use av_log() instead.
206 Casts should be used only when necessary. Unneeded parentheses
207 should also be avoided if they don't make the code easier to understand.
210 @subsection Editor configuration
211 In order to configure Vim to follow FFmpeg formatting conventions, paste
212 the following snippet into your @file{.vimrc}:
214 " indentation rules for FFmpeg: 4 spaces, no tabs
220 " Allow tabs in Makefiles.
221 autocmd FileType make,automake set noexpandtab shiftwidth=8 softtabstop=8
222 " Trailing whitespace and tabs are forbidden, so highlight them.
223 highlight ForbiddenWhitespace ctermbg=red guibg=red
224 match ForbiddenWhitespace /\s\+$\|\t/
225 " Do not highlight spaces at the end of line while typing on that line.
226 autocmd InsertEnter * match ForbiddenWhitespace /\t\|\s\+\%#\@@<!$/
229 For Emacs, add these roughly equivalent lines to your @file{.emacs.d/init.el}:
231 (c-add-style "ffmpeg"
234 (indent-tabs-mode . nil)
235 (show-trailing-whitespace . t)
237 (statement-cont . (c-lineup-assignments +)))
240 (setq c-default-style "ffmpeg")
243 @section Development Policy
247 Contributions should be licensed under the
248 @uref{http://www.gnu.org/licenses/lgpl-2.1.html, LGPL 2.1},
249 including an "or any later version" clause, or, if you prefer
250 a gift-style license, the
251 @uref{http://www.isc.org/software/license/, ISC} or
252 @uref{http://mit-license.org/, MIT} license.
253 @uref{http://www.gnu.org/licenses/gpl-2.0.html, GPL 2} including
254 an "or any later version" clause is also acceptable, but LGPL is
258 You must not commit code which breaks FFmpeg! (Meaning unfinished but
259 enabled code which breaks compilation or compiles but does not work or
260 breaks the regression tests)
261 You can commit unfinished stuff (for testing etc), but it must be disabled
262 (#ifdef etc) by default so it does not interfere with other developers'
266 The commit message should have a short first line in the form of
267 a @samp{topic: short description} as a header, separated by a newline
268 from the body consisting of an explanation of why the change is necessary.
269 If the commit fixes a known bug on the bug tracker, the commit message
270 should include its bug ID. Referring to the issue on the bug tracker does
271 not exempt you from writing an excerpt of the bug in the commit message.
274 You do not have to over-test things. If it works for you, and you think it
275 should work for others, then commit. If your code has problems
276 (portability, triggers compiler bugs, unusual environment etc) they will be
277 reported and eventually fixed.
280 Do not commit unrelated changes together, split them into self-contained
281 pieces. Also do not forget that if part B depends on part A, but A does not
282 depend on B, then A can and should be committed first and separate from B.
283 Keeping changes well split into self-contained parts makes reviewing and
284 understanding them on the commit log mailing list easier. This also helps
285 in case of debugging later on.
286 Also if you have doubts about splitting or not splitting, do not hesitate to
287 ask/discuss it on the developer mailing list.
290 Do not change behavior of the programs (renaming options etc) or public
291 API or ABI without first discussing it on the ffmpeg-devel mailing list.
292 Do not remove functionality from the code. Just improve!
294 Note: Redundant code can be removed.
297 Do not commit changes to the build system (Makefiles, configure script)
298 which change behavior, defaults etc, without asking first. The same
299 applies to compiler warning fixes, trivial looking fixes and to code
300 maintained by other developers. We usually have a reason for doing things
301 the way we do. Send your changes as patches to the ffmpeg-devel mailing
302 list, and if the code maintainers say OK, you may commit. This does not
303 apply to files you wrote and/or maintain.
306 We refuse source indentation and other cosmetic changes if they are mixed
307 with functional changes, such commits will be rejected and removed. Every
308 developer has his own indentation style, you should not change it. Of course
309 if you (re)write something, you can use your own style, even though we would
310 prefer if the indentation throughout FFmpeg was consistent (Many projects
311 force a given indentation style - we do not.). If you really need to make
312 indentation changes (try to avoid this), separate them strictly from real
315 NOTE: If you had to put if()@{ .. @} over a large (> 5 lines) chunk of code,
316 then either do NOT change the indentation of the inner part within (do not
317 move it to the right)! or do so in a separate commit
320 Always fill out the commit log message. Describe in a few lines what you
321 changed and why. You can refer to mailing list postings if you fix a
322 particular bug. Comments such as "fixed!" or "Changed it." are unacceptable.
324 area changed: Short 1 line description
326 details describing what and why and giving references.
329 Make sure the author of the commit is set correctly. (see git commit --author)
330 If you apply a patch, send an
331 answer to ffmpeg-devel (or wherever you got the patch from) saying that
332 you applied the patch.
335 When applying patches that have been discussed (at length) on the mailing
336 list, reference the thread in the log message.
339 Do NOT commit to code actively maintained by others without permission.
340 Send a patch to ffmpeg-devel instead. If no one answers within a reasonable
341 timeframe (12h for build failures and security fixes, 3 days small changes,
342 1 week for big patches) then commit your patch if you think it is OK.
343 Also note, the maintainer can simply ask for more time to review!
346 Subscribe to the ffmpeg-cvslog mailing list. The diffs of all commits
347 are sent there and reviewed by all the other developers. Bugs and possible
348 improvements or general questions regarding commits are discussed there. We
349 expect you to react if problems with your code are uncovered.
352 Update the documentation if you change behavior or add features. If you are
353 unsure how best to do this, send a patch to ffmpeg-devel, the documentation
354 maintainer(s) will review and commit your stuff.
357 Try to keep important discussions and requests (also) on the public
358 developer mailing list, so that all developers can benefit from them.
361 Never write to unallocated memory, never write over the end of arrays,
362 always check values read from some untrusted source before using them
363 as array index or other risky things.
366 Remember to check if you need to bump versions for the specific libav*
367 parts (libavutil, libavcodec, libavformat) you are changing. You need
368 to change the version integer.
369 Incrementing the first component means no backward compatibility to
370 previous versions (e.g. removal of a function from the public API).
371 Incrementing the second component means backward compatible change
372 (e.g. addition of a function to the public API or extension of an
373 existing data structure).
374 Incrementing the third component means a noteworthy binary compatible
375 change (e.g. encoder bug fix that matters for the decoder). The third
376 component always starts at 100 to distinguish FFmpeg from Libav.
379 Compiler warnings indicate potential bugs or code with bad style. If a type of
380 warning always points to correct and clean code, that warning should
381 be disabled, not the code changed.
382 Thus the remaining warnings can either be bugs or correct code.
383 If it is a bug, the bug has to be fixed. If it is not, the code should
384 be changed to not generate a warning unless that causes a slowdown
385 or obfuscates the code.
388 If you add a new file, give it a proper license header. Do not copy and
389 paste it from a random place, use an existing file as template.
392 We think our rules are not too hard. If you have comments, contact us.
394 @anchor{Submitting patches}
395 @section Submitting patches
397 First, read the @ref{Coding Rules} above if you did not yet, in particular
398 the rules regarding patch submission.
400 When you submit your patch, please use @code{git format-patch} or
401 @code{git send-email}. We cannot read other diffs :-)
403 Also please do not submit a patch which contains several unrelated changes.
404 Split it into separate, self-contained pieces. This does not mean splitting
405 file by file. Instead, make the patch as small as possible while still
406 keeping it as a logical unit that contains an individual change, even
407 if it spans multiple files. This makes reviewing your patches much easier
408 for us and greatly increases your chances of getting your patch applied.
410 Use the patcheck tool of FFmpeg to check your patch.
411 The tool is located in the tools directory.
413 Run the @ref{Regression tests} before submitting a patch in order to verify
414 it does not cause unexpected problems.
416 It also helps quite a bit if you tell us what the patch does (for example
417 'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant
420 Also please if you send several patches, send each patch as a separate mail,
421 do not attach several unrelated patches to the same mail.
423 Patches should be posted to the
424 @uref{http://lists.ffmpeg.org/mailman/listinfo/ffmpeg-devel, ffmpeg-devel}
425 mailing list. Use @code{git send-email} when possible since it will properly
426 send patches without requiring extra care. If you cannot, then send patches
427 as base64-encoded attachments, so your patch is not trashed during
430 Your patch will be reviewed on the mailing list. You will likely be asked
431 to make some changes and are expected to send in an improved version that
432 incorporates the requests from the review. This process may go through
433 several iterations. Once your patch is deemed good enough, some developer
434 will pick it up and commit it to the official FFmpeg tree.
436 Give us a few days to react. But if some time passes without reaction,
437 send a reminder by email. Your patch should eventually be dealt with.
440 @section New codecs or formats checklist
444 Did you use av_cold for codec initialization and close functions?
447 Did you add a long_name under NULL_IF_CONFIG_SMALL to the AVCodec or
448 AVInputFormat/AVOutputFormat struct?
451 Did you bump the minor version number (and reset the micro version
452 number) in @file{libavcodec/version.h} or @file{libavformat/version.h}?
455 Did you register it in @file{allcodecs.c} or @file{allformats.c}?
458 Did you add the AVCodecID to @file{avcodec.h}?
459 When adding new codec IDs, also add an entry to the codec descriptor
460 list in @file{libavcodec/codec_desc.c}.
463 If it has a FourCC, did you add it to @file{libavformat/riff.c},
464 even if it is only a decoder?
467 Did you add a rule to compile the appropriate files in the Makefile?
468 Remember to do this even if you're just adding a format to a file that is
469 already being compiled by some other rule, like a raw demuxer.
472 Did you add an entry to the table of supported formats or codecs in
473 @file{doc/general.texi}?
476 Did you add an entry in the Changelog?
479 If it depends on a parser or a library, did you add that dependency in
483 Did you @code{git add} the appropriate files before committing?
486 Did you make sure it compiles standalone, i.e. with
487 @code{configure --disable-everything --enable-decoder=foo}
488 (or @code{--enable-demuxer} or whatever your component is)?
492 @section patch submission checklist
496 Does @code{make fate} pass with the patch applied?
499 Was the patch generated with git format-patch or send-email?
502 Did you sign off your patch? (git commit -s)
503 See @url{http://git.kernel.org/?p=linux/kernel/git/torvalds/linux.git;a=blob_plain;f=Documentation/SubmittingPatches} for the meaning
507 Did you provide a clear git commit log message?
510 Is the patch against latest FFmpeg git master branch?
513 Are you subscribed to ffmpeg-devel?
514 (the list is subscribers only due to spam)
517 Have you checked that the changes are minimal, so that the same cannot be
518 achieved with a smaller patch and/or simpler final code?
521 If the change is to speed critical code, did you benchmark it?
524 If you did any benchmarks, did you provide them in the mail?
527 Have you checked that the patch does not introduce buffer overflows or
528 other security issues?
531 Did you test your decoder or demuxer against damaged data? If no, see
532 tools/trasher, the noise bitstream filter, and
533 @uref{http://caca.zoy.org/wiki/zzuf, zzuf}. Your decoder or demuxer
534 should not crash, end in a (near) infinite loop, or allocate ridiculous
535 amounts of memory when fed damaged data.
538 Does the patch not mix functional and cosmetic changes?
541 Did you add tabs or trailing whitespace to the code? Both are forbidden.
544 Is the patch attached to the email you send?
547 Is the mime type of the patch correct? It should be text/x-diff or
548 text/x-patch or at least text/plain and not application/octet-stream.
551 If the patch fixes a bug, did you provide a verbose analysis of the bug?
554 If the patch fixes a bug, did you provide enough information, including
555 a sample, so the bug can be reproduced and the fix can be verified?
556 Note please do not attach samples >100k to mails but rather provide a
557 URL, you can upload to ftp://upload.ffmpeg.org
560 Did you provide a verbose summary about what the patch does change?
563 Did you provide a verbose explanation why it changes things like it does?
566 Did you provide a verbose summary of the user visible advantages and
567 disadvantages if the patch is applied?
570 Did you provide an example so we can verify the new feature added by the
574 If you added a new file, did you insert a license header? It should be
575 taken from FFmpeg, not randomly copied and pasted from somewhere else.
578 You should maintain alphabetical order in alphabetically ordered lists as
579 long as doing so does not break API/ABI compatibility.
582 Lines with similar content should be aligned vertically when doing so
583 improves readability.
586 Consider to add a regression test for your code.
589 If you added YASM code please check that things still work with --disable-yasm
592 Make sure you check the return values of function and return appropriate
593 error codes. Especially memory allocation functions like @code{av_malloc()}
594 are notoriously left unchecked, which is a serious problem.
597 Test your code with valgrind and or Address Sanitizer to ensure it's free
598 of leaks, out of array accesses, etc.
601 @section Patch review process
603 All patches posted to ffmpeg-devel will be reviewed, unless they contain a
604 clear note that the patch is not for the git master branch.
605 Reviews and comments will be posted as replies to the patch on the
606 mailing list. The patch submitter then has to take care of every comment,
607 that can be by resubmitting a changed patch or by discussion. Resubmitted
608 patches will themselves be reviewed like any other patch. If at some point
609 a patch passes review with no comments then it is approved, that can for
610 simple and small patches happen immediately while large patches will generally
611 have to be changed and reviewed many times before they are approved.
612 After a patch is approved it will be committed to the repository.
614 We will review all submitted patches, but sometimes we are quite busy so
615 especially for large patches this can take several weeks.
617 If you feel that the review process is too slow and you are willing to try to
618 take over maintainership of the area of code you change then just clone
619 git master and maintain the area of code there. We will merge each area from
620 where its best maintained.
622 When resubmitting patches, please do not make any significant changes
623 not related to the comments received during review. Such patches will
624 be rejected. Instead, submit significant changes or new features as
627 @anchor{Regression tests}
628 @section Regression tests
630 Before submitting a patch (or committing to the repository), you should at least
631 test that you did not break anything.
633 Running 'make fate' accomplishes this, please see @url{fate.html} for details.
635 [Of course, some patches may change the results of the regression tests. In
636 this case, the reference results of the regression tests shall be modified
639 @subsection Adding files to the fate-suite dataset
641 When there is no muxer or encoder available to generate test media for a
642 specific test then the media has to be inlcuded in the fate-suite.
643 First please make sure that the sample file is as small as possible to test the
644 respective decoder or demuxer sufficiently. Large files increase network
645 bandwidth and disk space requirements.
646 Once you have a working fate test and fate sample, provide in the commit
647 message or introductionary message for the patch series that you post to
648 the ffmpeg-devel mailing list, a direct link to download the sample media.
651 @subsection Visualizing Test Coverage
653 The FFmpeg build system allows visualizing the test coverage in an easy
654 manner with the coverage tools @code{gcov}/@code{lcov}. This involves
659 Configure to compile with instrumentation enabled:
660 @code{configure --toolchain=gcov}.
663 Run your test case, either manually or via FATE. This can be either
664 the full FATE regression suite, or any arbitrary invocation of any
665 front-end tool provided by FFmpeg, in any combination.
668 Run @code{make lcov} to generate coverage data in HTML format.
671 View @code{lcov/index.html} in your preferred HTML viewer.
674 You can use the command @code{make lcov-reset} to reset the coverage
675 measurements. You will need to rerun @code{make lcov} after running a
678 @subsection Using Valgrind
680 The configure script provides a shortcut for using valgrind to spot bugs
681 related to memory handling. Just add the option
682 @code{--toolchain=valgrind-memcheck} or @code{--toolchain=valgrind-massif}
683 to your configure line, and reasonable defaults will be set for running
684 FATE under the supervision of either the @strong{memcheck} or the
685 @strong{massif} tool of the valgrind suite.
687 In case you need finer control over how valgrind is invoked, use the
688 @code{--target-exec='valgrind <your_custom_valgrind_options>} option in
689 your configure line instead.
691 @anchor{Release process}
692 @section Release process
694 FFmpeg maintains a set of @strong{release branches}, which are the
695 recommended deliverable for system integrators and distributors (such as
696 Linux distributions, etc.). At regular times, a @strong{release
697 manager} prepares, tests and publishes tarballs on the
698 @url{http://ffmpeg.org} website.
700 There are two kinds of releases:
704 @strong{Major releases} always include the latest and greatest
705 features and functionality.
708 @strong{Point releases} are cut from @strong{release} branches,
709 which are named @code{release/X}, with @code{X} being the release
713 Note that we promise to our users that shared libraries from any FFmpeg
714 release never break programs that have been @strong{compiled} against
715 previous versions of @strong{the same release series} in any case!
717 However, from time to time, we do make API changes that require adaptations
718 in applications. Such changes are only allowed in (new) major releases and
719 require further steps such as bumping library version numbers and/or
720 adjustments to the symbol versioning file. Please discuss such changes
721 on the @strong{ffmpeg-devel} mailing list in time to allow forward planning.
723 @anchor{Criteria for Point Releases}
724 @subsection Criteria for Point Releases
726 Changes that match the following criteria are valid candidates for
727 inclusion into a point release:
731 Fixes a security issue, preferably identified by a @strong{CVE
732 number} issued by @url{http://cve.mitre.org/}.
735 Fixes a documented bug in @url{https://trac.ffmpeg.org}.
738 Improves the included documentation.
741 Retains both source code and binary compatibility with previous
742 point releases of the same release branch.
745 The order for checking the rules is (1 OR 2 OR 3) AND 4.
748 @subsection Release Checklist
750 The release process involves the following steps:
754 Ensure that the @file{RELEASE} file contains the version number for
755 the upcoming release.
758 Add the release at @url{https://trac.ffmpeg.org/admin/ticket/versions}.
761 Announce the intent to do a release to the mailing list.
764 Make sure all relevant security fixes have been backported. See
765 @url{https://ffmpeg.org/security.html}.
768 Ensure that the FATE regression suite still passes in the release
769 branch on at least @strong{i386} and @strong{amd64}
770 (cf. @ref{Regression tests}).
773 Prepare the release tarballs in @code{bz2} and @code{gz} formats, and
774 supplementing files that contain @code{gpg} signatures
777 Publish the tarballs at @url{http://ffmpeg.org/releases}. Create and
778 push an annotated tag in the form @code{nX}, with @code{X}
779 containing the version number.
782 Propose and send a patch to the @strong{ffmpeg-devel} mailing list
783 with a news entry for the website.
786 Publish the news entry.
789 Send announcement to the mailing list.