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