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