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