Merge commit 'f2960097e42ddf9a356bab6547f87906f6999e0a'
[ffmpeg.git] / doc / developer.texi
1 \input texinfo @c -*- texinfo -*-
2
3 @settitle Developer Documentation
4 @titlepage
5 @center @titlefont{Developer Documentation}
6 @end titlepage
7
8 @top
9
10 @contents
11
12 @chapter Developers Guide
13
14 @section API
15 @itemize @bullet
16 @item libavcodec is the library containing the codecs (both encoding and
17 decoding). Look at @file{doc/examples/decoding_encoding.c} to see how to use
18 it.
19
20 @item libavformat is the library containing the file format handling (mux and
21 demux code for several formats). Look at @file{ffplay.c} to use it in a
22 player. See @file{doc/examples/muxing.c} to use it to generate audio or video
23 streams.
24
25 @end itemize
26
27 @section Integrating libavcodec or libavformat in your program
28
29 You can integrate all the source code of the libraries to link them
30 statically to avoid any version problem. All you need is to provide a
31 'config.mak' and a 'config.h' in the parent directory. See the defines
32 generated by ./configure to understand what is needed.
33
34 You can use libavcodec or libavformat in your commercial program, but
35 @emph{any patch you make must be published}. The best way to proceed is
36 to send your patches to the FFmpeg mailing list.
37
38 @section Contributing
39
40 There are 3 ways by which code gets into ffmpeg.
41 @itemize @bullet
42 @item Submitting Patches to the main developer mailing list
43       see @ref{Submitting patches} for details.
44 @item Directly committing changes to the main tree.
45 @item Committing changes to a git clone, for example on github.com or
46       gitorious.org. And asking us to merge these changes.
47 @end itemize
48
49 Whichever way, changes should be reviewed by the maintainer of the code
50 before they are committed. And they should follow the @ref{Coding Rules}.
51 The developer making the commit and the author are responsible for their changes
52 and should try to fix issues their commit causes.
53
54 @anchor{Coding Rules}
55 @section Coding Rules
56
57 @subsection Code formatting conventions
58
59 There are the following guidelines regarding the indentation in files:
60 @itemize @bullet
61 @item
62 Indent size is 4.
63 @item
64 The TAB character is forbidden outside of Makefiles as is any
65 form of trailing whitespace. Commits containing either will be
66 rejected by the git repository.
67 @item
68 You should try to limit your code lines to 80 characters; however, do so if
69 and only if this improves readability.
70 @end itemize
71 The presentation is one inspired by 'indent -i4 -kr -nut'.
72
73 The main priority in FFmpeg is simplicity and small code size in order to
74 minimize the bug count.
75
76 @subsection Comments
77 Use the JavaDoc/Doxygen  format (see examples below) so that code documentation
78 can be generated automatically. All nontrivial functions should have a comment
79 above them explaining what the function does, even if it is just one sentence.
80 All structures and their member variables should be documented, too.
81
82 Avoid Qt-style and similar Doxygen syntax with @code{!} in it, i.e. replace
83 @code{//!} with @code{///} and similar.  Also @@ syntax should be employed
84 for markup commands, i.e. use @code{@@param} and not @code{\param}.
85
86 @example
87 /**
88  * @@file
89  * MPEG codec.
90  * @@author ...
91  */
92
93 /**
94  * Summary sentence.
95  * more text ...
96  * ...
97  */
98 typedef struct Foobar@{
99     int var1; /**< var1 description */
100     int var2; ///< var2 description
101     /** var3 description */
102     int var3;
103 @} Foobar;
104
105 /**
106  * Summary sentence.
107  * more text ...
108  * ...
109  * @@param my_parameter description of my_parameter
110  * @@return return value description
111  */
112 int myfunc(int my_parameter)
113 ...
114 @end example
115
116 @subsection C language features
117
118 FFmpeg is programmed in the ISO C90 language with a few additional
119 features from ISO C99, namely:
120 @itemize @bullet
121 @item
122 the @samp{inline} keyword;
123 @item
124 @samp{//} comments;
125 @item
126 designated struct initializers (@samp{struct s x = @{ .i = 17 @};})
127 @item
128 compound literals (@samp{x = (struct s) @{ 17, 23 @};})
129 @end itemize
130
131 These features are supported by all compilers we care about, so we will not
132 accept patches to remove their use unless they absolutely do not impair
133 clarity and performance.
134
135 All code must compile with recent versions of GCC and a number of other
136 currently supported compilers. To ensure compatibility, please do not use
137 additional C99 features or GCC extensions. Especially watch out for:
138 @itemize @bullet
139 @item
140 mixing statements and declarations;
141 @item
142 @samp{long long} (use @samp{int64_t} instead);
143 @item
144 @samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar;
145 @item
146 GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
147 @end itemize
148
149 @subsection Naming conventions
150 All names are using underscores (_), not CamelCase. For example, @samp{avfilter_get_video_buffer} is
151 a valid function name and @samp{AVFilterGetVideo} is not. The exception from this are type names, like
152 for example structs and enums; they should always be in the CamelCase
153
154
155 There are following conventions for naming variables and functions:
156 @itemize @bullet
157 @item
158 For local variables no prefix is required.
159 @item
160 For variables and functions declared as @code{static} no prefixes are required.
161 @item
162 For variables and functions used internally by the library, @code{ff_} prefix
163 should be used.
164 For example, @samp{ff_w64_demuxer}.
165 @item
166 For variables and functions used internally across multiple libraries, use
167 @code{avpriv_}. For example, @samp{avpriv_aac_parse_header}.
168 @item
169 For exported names, each library has its own prefixes. Just check the existing
170 code and name accordingly.
171 @end itemize
172
173 @subsection Miscellaneous conventions
174 @itemize @bullet
175 @item
176 fprintf and printf are forbidden in libavformat and libavcodec,
177 please use av_log() instead.
178 @item
179 Casts should be used only when necessary. Unneeded parentheses
180 should also be avoided if they don't make the code easier to understand.
181 @end itemize
182
183 @subsection Editor configuration
184 In order to configure Vim to follow FFmpeg formatting conventions, paste
185 the following snippet into your @file{.vimrc}:
186 @example
187 " indentation rules for FFmpeg: 4 spaces, no tabs
188 set expandtab
189 set shiftwidth=4
190 set softtabstop=4
191 set cindent
192 set cinoptions=(0
193 " Allow tabs in Makefiles.
194 autocmd FileType make set noexpandtab shiftwidth=8 softtabstop=8
195 " Trailing whitespace and tabs are forbidden, so highlight them.
196 highlight ForbiddenWhitespace ctermbg=red guibg=red
197 match ForbiddenWhitespace /\s\+$\|\t/
198 " Do not highlight spaces at the end of line while typing on that line.
199 autocmd InsertEnter * match ForbiddenWhitespace /\t\|\s\+\%#\@@<!$/
200 @end example
201
202 For Emacs, add these roughly equivalent lines to your @file{.emacs.d/init.el}:
203 @example
204 (c-add-style "ffmpeg"
205              '("k&r"
206                (c-basic-offset . 4)
207                (indent-tabs-mode . nil)
208                (show-trailing-whitespace . t)
209                (c-offsets-alist
210                 (statement-cont . (c-lineup-assignments +)))
211                )
212              )
213 (setq c-default-style "ffmpeg")
214 @end example
215
216 @section Development Policy
217
218 @enumerate
219 @item
220    Contributions should be licensed under the
221    @uref{http://www.gnu.org/licenses/lgpl-2.1.html, LGPL 2.1},
222    including an "or any later version" clause, or, if you prefer
223    a gift-style license, the
224    @uref{http://www.isc.org/software/license/, ISC} or
225    @uref{http://mit-license.org/, MIT} license.
226    @uref{http://www.gnu.org/licenses/gpl-2.0.html, GPL 2} including
227    an "or any later version" clause is also acceptable, but LGPL is
228    preferred.
229 @item
230    You must not commit code which breaks FFmpeg! (Meaning unfinished but
231    enabled code which breaks compilation or compiles but does not work or
232    breaks the regression tests)
233    You can commit unfinished stuff (for testing etc), but it must be disabled
234    (#ifdef etc) by default so it does not interfere with other developers'
235    work.
236 @item
237    The commit message should have a short first line in the form of
238    a @samp{topic: short description} as a header, separated by a newline
239    from the body consisting of an explanation of why the change is necessary.
240    If the commit fixes a known bug on the bug tracker, the commit message
241    should include its bug ID. Referring to the issue on the bug tracker does
242    not exempt you from writing an excerpt of the bug in the commit message.
243 @item
244    You do not have to over-test things. If it works for you, and you think it
245    should work for others, then commit. If your code has problems
246    (portability, triggers compiler bugs, unusual environment etc) they will be
247    reported and eventually fixed.
248 @item
249    Do not commit unrelated changes together, split them into self-contained
250    pieces. Also do not forget that if part B depends on part A, but A does not
251    depend on B, then A can and should be committed first and separate from B.
252    Keeping changes well split into self-contained parts makes reviewing and
253    understanding them on the commit log mailing list easier. This also helps
254    in case of debugging later on.
255    Also if you have doubts about splitting or not splitting, do not hesitate to
256    ask/discuss it on the developer mailing list.
257 @item
258    Do not change behavior of the programs (renaming options etc) or public
259    API or ABI without first discussing it on the ffmpeg-devel mailing list.
260    Do not remove functionality from the code. Just improve!
261
262    Note: Redundant code can be removed.
263 @item
264    Do not commit changes to the build system (Makefiles, configure script)
265    which change behavior, defaults etc, without asking first. The same
266    applies to compiler warning fixes, trivial looking fixes and to code
267    maintained by other developers. We usually have a reason for doing things
268    the way we do. Send your changes as patches to the ffmpeg-devel mailing
269    list, and if the code maintainers say OK, you may commit. This does not
270    apply to files you wrote and/or maintain.
271 @item
272    We refuse source indentation and other cosmetic changes if they are mixed
273    with functional changes, such commits will be rejected and removed. Every
274    developer has his own indentation style, you should not change it. Of course
275    if you (re)write something, you can use your own style, even though we would
276    prefer if the indentation throughout FFmpeg was consistent (Many projects
277    force a given indentation style - we do not.). If you really need to make
278    indentation changes (try to avoid this), separate them strictly from real
279    changes.
280
281    NOTE: If you had to put if()@{ .. @} over a large (> 5 lines) chunk of code,
282    then either do NOT change the indentation of the inner part within (do not
283    move it to the right)! or do so in a separate commit
284 @item
285    Always fill out the commit log message. Describe in a few lines what you
286    changed and why. You can refer to mailing list postings if you fix a
287    particular bug. Comments such as "fixed!" or "Changed it." are unacceptable.
288    Recommended format:
289    area changed: Short 1 line description
290
291    details describing what and why and giving references.
292 @item
293    Make sure the author of the commit is set correctly. (see git commit --author)
294    If you apply a patch, send an
295    answer to ffmpeg-devel (or wherever you got the patch from) saying that
296    you applied the patch.
297 @item
298    When applying patches that have been discussed (at length) on the mailing
299    list, reference the thread in the log message.
300 @item
301     Do NOT commit to code actively maintained by others without permission.
302     Send a patch to ffmpeg-devel instead. If no one answers within a reasonable
303     timeframe (12h for build failures and security fixes, 3 days small changes,
304     1 week for big patches) then commit your patch if you think it is OK.
305     Also note, the maintainer can simply ask for more time to review!
306 @item
307     Subscribe to the ffmpeg-cvslog mailing list. The diffs of all commits
308     are sent there and reviewed by all the other developers. Bugs and possible
309     improvements or general questions regarding commits are discussed there. We
310     expect you to react if problems with your code are uncovered.
311 @item
312     Update the documentation if you change behavior or add features. If you are
313     unsure how best to do this, send a patch to ffmpeg-devel, the documentation
314     maintainer(s) will review and commit your stuff.
315 @item
316     Try to keep important discussions and requests (also) on the public
317     developer mailing list, so that all developers can benefit from them.
318 @item
319     Never write to unallocated memory, never write over the end of arrays,
320     always check values read from some untrusted source before using them
321     as array index or other risky things.
322 @item
323     Remember to check if you need to bump versions for the specific libav*
324     parts (libavutil, libavcodec, libavformat) you are changing. You need
325     to change the version integer.
326     Incrementing the first component means no backward compatibility to
327     previous versions (e.g. removal of a function from the public API).
328     Incrementing the second component means backward compatible change
329     (e.g. addition of a function to the public API or extension of an
330     existing data structure).
331     Incrementing the third component means a noteworthy binary compatible
332     change (e.g. encoder bug fix that matters for the decoder). The third
333     component always starts at 100 to distinguish FFmpeg from Libav.
334 @item
335     Compiler warnings indicate potential bugs or code with bad style. If a type of
336     warning always points to correct and clean code, that warning should
337     be disabled, not the code changed.
338     Thus the remaining warnings can either be bugs or correct code.
339     If it is a bug, the bug has to be fixed. If it is not, the code should
340     be changed to not generate a warning unless that causes a slowdown
341     or obfuscates the code.
342 @item
343     If you add a new file, give it a proper license header. Do not copy and
344     paste it from a random place, use an existing file as template.
345 @end enumerate
346
347 We think our rules are not too hard. If you have comments, contact us.
348
349 @anchor{Submitting patches}
350 @section Submitting patches
351
352 First, read the @ref{Coding Rules} above if you did not yet, in particular
353 the rules regarding patch submission.
354
355 When you submit your patch, please use @code{git format-patch} or
356 @code{git send-email}. We cannot read other diffs :-)
357
358 Also please do not submit a patch which contains several unrelated changes.
359 Split it into separate, self-contained pieces. This does not mean splitting
360 file by file. Instead, make the patch as small as possible while still
361 keeping it as a logical unit that contains an individual change, even
362 if it spans multiple files. This makes reviewing your patches much easier
363 for us and greatly increases your chances of getting your patch applied.
364
365 Use the patcheck tool of FFmpeg to check your patch.
366 The tool is located in the tools directory.
367
368 Run the @ref{Regression tests} before submitting a patch in order to verify
369 it does not cause unexpected problems.
370
371 It also helps quite a bit if you tell us what the patch does (for example
372 'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant
373 and has no lrint()')
374
375 Also please if you send several patches, send each patch as a separate mail,
376 do not attach several unrelated patches to the same mail.
377
378 Patches should be posted to the
379 @uref{http://lists.ffmpeg.org/mailman/listinfo/ffmpeg-devel, ffmpeg-devel}
380 mailing list. Use @code{git send-email} when possible since it will properly
381 send patches without requiring extra care. If you cannot, then send patches
382 as base64-encoded attachments, so your patch is not trashed during
383 transmission.
384
385 Your patch will be reviewed on the mailing list. You will likely be asked
386 to make some changes and are expected to send in an improved version that
387 incorporates the requests from the review. This process may go through
388 several iterations. Once your patch is deemed good enough, some developer
389 will pick it up and commit it to the official FFmpeg tree.
390
391 Give us a few days to react. But if some time passes without reaction,
392 send a reminder by email. Your patch should eventually be dealt with.
393
394
395 @section New codecs or formats checklist
396
397 @enumerate
398 @item
399     Did you use av_cold for codec initialization and close functions?
400 @item
401     Did you add a long_name under NULL_IF_CONFIG_SMALL to the AVCodec or
402     AVInputFormat/AVOutputFormat struct?
403 @item
404     Did you bump the minor version number (and reset the micro version
405     number) in @file{libavcodec/version.h} or @file{libavformat/version.h}?
406 @item
407     Did you register it in @file{allcodecs.c} or @file{allformats.c}?
408 @item
409     Did you add the AVCodecID to @file{avcodec.h}?
410     When adding new codec IDs, also add an entry to the codec descriptor
411     list in @file{libavcodec/codec_desc.c}.
412 @item
413     If it has a FourCC, did you add it to @file{libavformat/riff.c},
414     even if it is only a decoder?
415 @item
416     Did you add a rule to compile the appropriate files in the Makefile?
417     Remember to do this even if you're just adding a format to a file that is
418     already being compiled by some other rule, like a raw demuxer.
419 @item
420     Did you add an entry to the table of supported formats or codecs in
421     @file{doc/general.texi}?
422 @item
423     Did you add an entry in the Changelog?
424 @item
425     If it depends on a parser or a library, did you add that dependency in
426     configure?
427 @item
428     Did you @code{git add} the appropriate files before committing?
429 @item
430     Did you make sure it compiles standalone, i.e. with
431     @code{configure --disable-everything --enable-decoder=foo}
432     (or @code{--enable-demuxer} or whatever your component is)?
433 @end enumerate
434
435
436 @section patch submission checklist
437
438 @enumerate
439 @item
440     Does @code{make fate} pass with the patch applied?
441 @item
442     Was the patch generated with git format-patch or send-email?
443 @item
444     Did you sign off your patch? (git commit -s)
445     See @url{http://git.kernel.org/?p=linux/kernel/git/torvalds/linux.git;a=blob_plain;f=Documentation/SubmittingPatches} for the meaning
446     of sign off.
447 @item
448     Did you provide a clear git commit log message?
449 @item
450     Is the patch against latest FFmpeg git master branch?
451 @item
452     Are you subscribed to ffmpeg-devel?
453     (the list is subscribers only due to spam)
454 @item
455     Have you checked that the changes are minimal, so that the same cannot be
456     achieved with a smaller patch and/or simpler final code?
457 @item
458     If the change is to speed critical code, did you benchmark it?
459 @item
460     If you did any benchmarks, did you provide them in the mail?
461 @item
462     Have you checked that the patch does not introduce buffer overflows or
463     other security issues?
464 @item
465     Did you test your decoder or demuxer against damaged data? If no, see
466     tools/trasher, the noise bitstream filter, and
467     @uref{http://caca.zoy.org/wiki/zzuf, zzuf}. Your decoder or demuxer
468     should not crash, end in a (near) infinite loop, or allocate ridiculous
469     amounts of memory when fed damaged data.
470 @item
471     Does the patch not mix functional and cosmetic changes?
472 @item
473     Did you add tabs or trailing whitespace to the code? Both are forbidden.
474 @item
475     Is the patch attached to the email you send?
476 @item
477     Is the mime type of the patch correct? It should be text/x-diff or
478     text/x-patch or at least text/plain and not application/octet-stream.
479 @item
480     If the patch fixes a bug, did you provide a verbose analysis of the bug?
481 @item
482     If the patch fixes a bug, did you provide enough information, including
483     a sample, so the bug can be reproduced and the fix can be verified?
484     Note please do not attach samples >100k to mails but rather provide a
485     URL, you can upload to ftp://upload.ffmpeg.org
486 @item
487     Did you provide a verbose summary about what the patch does change?
488 @item
489     Did you provide a verbose explanation why it changes things like it does?
490 @item
491     Did you provide a verbose summary of the user visible advantages and
492     disadvantages if the patch is applied?
493 @item
494     Did you provide an example so we can verify the new feature added by the
495     patch easily?
496 @item
497     If you added a new file, did you insert a license header? It should be
498     taken from FFmpeg, not randomly copied and pasted from somewhere else.
499 @item
500     You should maintain alphabetical order in alphabetically ordered lists as
501     long as doing so does not break API/ABI compatibility.
502 @item
503     Lines with similar content should be aligned vertically when doing so
504     improves readability.
505 @item
506     Consider to add a regression test for your code.
507 @item
508     If you added YASM code please check that things still work with --disable-yasm
509 @item
510     Make sure you check the return values of function and return appropriate
511     error codes. Especially memory allocation functions like @code{av_malloc()}
512     are notoriously left unchecked, which is a serious problem.
513 @item
514     Test your code with valgrind and or Address Sanitizer to ensure it's free
515     of leaks, out of array accesses, etc.
516 @end enumerate
517
518 @section Patch review process
519
520 All patches posted to ffmpeg-devel will be reviewed, unless they contain a
521 clear note that the patch is not for the git master branch.
522 Reviews and comments will be posted as replies to the patch on the
523 mailing list. The patch submitter then has to take care of every comment,
524 that can be by resubmitting a changed patch or by discussion. Resubmitted
525 patches will themselves be reviewed like any other patch. If at some point
526 a patch passes review with no comments then it is approved, that can for
527 simple and small patches happen immediately while large patches will generally
528 have to be changed and reviewed many times before they are approved.
529 After a patch is approved it will be committed to the repository.
530
531 We will review all submitted patches, but sometimes we are quite busy so
532 especially for large patches this can take several weeks.
533
534 If you feel that the review process is too slow and you are willing to try to
535 take over maintainership of the area of code you change then just clone
536 git master and maintain the area of code there. We will merge each area from
537 where its best maintained.
538
539 When resubmitting patches, please do not make any significant changes
540 not related to the comments received during review. Such patches will
541 be rejected. Instead, submit significant changes or new features as
542 separate patches.
543
544 @anchor{Regression tests}
545 @section Regression tests
546
547 Before submitting a patch (or committing to the repository), you should at least
548 test that you did not break anything.
549
550 Running 'make fate' accomplishes this, please see @url{fate.html} for details.
551
552 [Of course, some patches may change the results of the regression tests. In
553 this case, the reference results of the regression tests shall be modified
554 accordingly].
555
556 @subsection Adding files to the fate-suite dataset
557
558 When there is no muxer or encoder available to generate test media for a
559 specific test then the media has to be inlcuded in the fate-suite.
560 First please make sure that the sample file is as small as possible to test the
561 respective decoder or demuxer sufficiently. Large files increase network
562 bandwidth and disk space requirements.
563 Once you have a working fate test and fate sample, provide in the commit
564 message or introductionary message for the patch series that you post to
565 the ffmpeg-devel mailing list, a direct link to download the sample media.
566
567
568 @bye