a63bea746c823abbfabb5e99869da2f0eb8e9d2c
[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{avplay.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 libav in your program
27
28 Shared libraries should be used whenever is possible in order to reduce
29 the effort distributors have to pour to support programs and to ensure
30 only the public api is used.
31
32 You can use Libav in your commercial program, but you must abide to the
33 license, LGPL or GPL depending on the specific features used, please refer
34 to @uref{http://libav.org/legal.html, our legal page} for a quick checklist and to
35 the following links for the exact text of each license:
36 @uref{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.GPLv2, GPL version 2},
37 @uref{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.GPLv3, GPL version 3},
38 @uref{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.LGPLv2.1, LGPL version 2.1},
39 @uref{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.LGPLv3, LGPL version 3}.
40 Any modification to the source code can be suggested for inclusion.
41 The best way to proceed is to send your patches to the
42 @uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel}
43 mailing list.
44
45 @anchor{Coding Rules}
46 @section Coding Rules
47
48 @subsection Code formatting conventions
49 The code is written in K&R C style. That means the following:
50 @itemize @bullet
51 @item
52 The control statements are formatted by putting space betwen the statement
53 and parenthesis in the following way:
54 @example
55 for (i = 0; i < filter->input_count; i++) @{
56 @end example
57 @item
58 The case statement is always located at the same level as the switch itself:
59 @example
60 switch (link->init_state) @{
61 case AVLINK_INIT:
62     continue;
63 case AVLINK_STARTINIT:
64     av_log(filter, AV_LOG_INFO, "circular filter chain detected");
65     return 0;
66 @end example
67 @item
68 Braces in function declarations are written on the new line:
69 @example
70 const char *avfilter_configuration(void)
71 @{
72     return LIBAV_CONFIGURATION;
73 @}
74 @end example
75 @item
76 In case of a single-statement if, no curly braces are required:
77 @example
78 if (!pic || !picref)
79     goto fail;
80 @end example
81 @item
82 Do not put spaces immediately inside parenthesis. @samp{if (ret)} is
83 a valid style; @samp{if ( ret )} is not.
84 @end itemize
85
86 There are the following guidelines regarding the indentation in files:
87 @itemize @bullet
88 @item
89 Indent size is 4.
90 @item
91 The TAB character is forbidden outside of Makefiles as is any
92 form of trailing whitespace. Commits containing either will be
93 rejected by the git repository.
94 @item
95 You should try to limit your code lines to 80 characters; however, do so if
96 and only if this improves readability.
97 @end itemize
98 The presentation is one inspired by 'indent -i4 -kr -nut'.
99
100 The main priority in Libav is simplicity and small code size in order to
101 minimize the bug count.
102
103 @subsection Comments
104 Use the JavaDoc/Doxygen  format (see examples below) so that code documentation
105 can be generated automatically. All nontrivial functions should have a comment
106 above them explaining what the function does, even if it is just one sentence.
107 All structures and their member variables should be documented, too.
108 @example
109 /**
110  * @@file
111  * MPEG codec.
112  * @@author ...
113  */
114
115 /**
116  * Summary sentence.
117  * more text ...
118  * ...
119  */
120 typedef struct Foobar@{
121     int var1; /**< var1 description */
122     int var2; ///< var2 description
123     /** var3 description */
124     int var3;
125 @} Foobar;
126
127 /**
128  * Summary sentence.
129  * more text ...
130  * ...
131  * @@param my_parameter description of my_parameter
132  * @@return return value description
133  */
134 int myfunc(int my_parameter)
135 ...
136 @end example
137
138 @subsection C language features
139
140 Libav is programmed in the ISO C90 language with a few additional
141 features from ISO C99, namely:
142 @itemize @bullet
143 @item
144 the @samp{inline} keyword;
145 @item
146 @samp{//} comments;
147 @item
148 designated struct initializers (@samp{struct s x = @{ .i = 17 @};})
149 @item
150 compound literals (@samp{x = (struct s) @{ 17, 23 @};})
151 @end itemize
152
153 These features are supported by all compilers we care about, so we will not
154 accept patches to remove their use unless they absolutely do not impair
155 clarity and performance.
156
157 All code must compile with recent versions of GCC and a number of other
158 currently supported compilers. To ensure compatibility, please do not use
159 additional C99 features or GCC extensions. Especially watch out for:
160 @itemize @bullet
161 @item
162 mixing statements and declarations;
163 @item
164 @samp{long long} (use @samp{int64_t} instead);
165 @item
166 @samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar;
167 @item
168 GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
169 @end itemize
170
171 @subsection Naming conventions
172 All names are using underscores (_), not CamelCase. For example,
173 @samp{avfilter_get_video_buffer} is a valid function name and
174 @samp{AVFilterGetVideo} is not. The only exception from this are structure
175 names; they should always be in the CamelCase
176
177 There are following conventions for naming variables and functions:
178 @itemize @bullet
179 @item
180 For local variables no prefix is required.
181 @item
182 For variables and functions declared as @code{static} no prefixes are required.
183 @item
184 For variables and functions used internally by the library, @code{ff_} prefix
185 should be used.
186 For example, @samp{ff_w64_demuxer}.
187 @item
188 For variables and functions used internally across multiple libraries, use
189 @code{avpriv_}. For example, @samp{avpriv_aac_parse_header}.
190 @item
191 For exported names, each library has its own prefixes. Just check the existing
192 code and name accordingly.
193 @end itemize
194
195 @subsection Miscellanous conventions
196 @itemize @bullet
197 @item
198 fprintf and printf are forbidden in libavformat and libavcodec,
199 please use av_log() instead.
200 @item
201 Casts should be used only when necessary. Unneeded parentheses
202 should also be avoided if they don't make the code easier to understand.
203 @end itemize
204
205 @section Development Policy
206
207 @enumerate
208 @item
209    Contributions should be licensed under the LGPL 2.1, including an
210    "or any later version" clause, or the MIT license.  GPL 2 including
211    an "or any later version" clause is also acceptable, but LGPL is
212    preferred.
213 @item
214    All the patches MUST be reviewed in the mailing list before they are
215    committed.
216 @item
217    The Libav coding style should remain consistent. Changes to
218    conform will be suggested during the review or implemented on commit.
219 @item
220    Patches should be generated using @code{git format-patch} or directly sent
221    using @code{git send-email}.
222    Please make sure you give the proper credit by setting the correct author
223    in the commit.
224 @item
225    The commit message should have a short first line in the form of
226    @samp{topic: short description} as header, separated by a newline
227    from the body consting in few lines explaining the reason of the patch.
228    Referring to the issue on the bug tracker does not exempt to report an
229    excerpt of the bug.
230 @item
231    Work in progress patches should be sent to the mailing list with the [WIP]
232    or the [RFC] tag.
233 @item
234    Branches in public personal repos are advised as way to
235    work on issues collaboratively.
236 @item
237    You do not have to over-test things. If it works for you and you think it
238    should work for others, send it to the mailing list for review.
239    If you have doubt about portability please state it in the submission so
240    people with specific hardware could test it.
241 @item
242    Do not commit unrelated changes together, split them into self-contained
243    pieces. Also do not forget that if part B depends on part A, but A does not
244    depend on B, then A can and should be committed first and separate from B.
245    Keeping changes well split into self-contained parts makes reviewing and
246    understanding them on the commit log mailing list easier. This also helps
247    in case of debugging later on.
248 @item
249    Patches that change behavior of the programs (renaming options etc) or
250    public API or ABI should be discussed in depth and possible few days should
251    pass between discussion and commit.
252    Changes to the build system (Makefiles, configure script) which alter
253    the expected behavior should be considered in the same regard.
254 @item
255    When applying patches that have been discussed (at length) on the mailing
256    list, reference the thread in the log message.
257 @item
258     Subscribe to the
259     @uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel} and
260     @uref{https://lists.libav.org/mailman/listinfo/libav-commits, libav-commits}
261     mailing lists.
262     Bugs and possible improvements or general questions regarding commits
263     are discussed on libav-devel. We expect you to react if problems with
264     your code are uncovered.
265 @item
266     Update the documentation if you change behavior or add features. If you are
267     unsure how best to do this, send an [RFC] patch to libav-devel.
268 @item
269     All discussions and decisions should be reported on the public developer
270     mailing list, so that there is a reference to them.
271     Other media (e.g. IRC) should be used for coordination and immediate
272     collaboration.
273 @item
274     Never write to unallocated memory, never write over the end of arrays,
275     always check values read from some untrusted source before using them
276     as array index or other risky things. Always use valgrind to doublecheck.
277 @item
278     Remember to check if you need to bump versions for the specific libav
279     parts (libavutil, libavcodec, libavformat) you are changing. You need
280     to change the version integer.
281     Incrementing the first component means no backward compatibility to
282     previous versions (e.g. removal of a function from the public API).
283     Incrementing the second component means backward compatible change
284     (e.g. addition of a function to the public API or extension of an
285     existing data structure).
286     Incrementing the third component means a noteworthy binary compatible
287     change (e.g. encoder bug fix that matters for the decoder).
288 @item
289     Compiler warnings indicate potential bugs or code with bad style.
290     If it is a bug, the bug has to be fixed. If it is not, the code should
291     be changed to not generate a warning unless that causes a slowdown
292     or obfuscates the code.
293     If a type of warning leads to too many false positives, that warning
294     should be disabled, not the code changed.
295 @item
296     If you add a new file, give it a proper license header. Do not copy and
297     paste it from a random place, use an existing file as template.
298 @end enumerate
299
300 We think our rules are not too hard. If you have comments, contact us.
301
302 Note, some rules were borrowed from the MPlayer project.
303
304 @section Submitting patches
305
306 First, read the @ref{Coding Rules} above if you did not yet, in particular
307 the rules regarding patch submission.
308
309 As stated already, please do not submit a patch which contains several
310 unrelated changes.
311 Split it into separate, self-contained pieces. This does not mean splitting
312 file by file. Instead, make the patch as small as possible while still
313 keeping it as a logical unit that contains an individual change, even
314 if it spans multiple files. This makes reviewing your patches much easier
315 for us and greatly increases your chances of getting your patch applied.
316
317 Use the patcheck tool of Libav to check your patch.
318 The tool is located in the tools directory.
319
320 Run the @ref{Regression Tests} before submitting a patch in order to verify
321 it does not cause unexpected problems.
322
323 Patches should be posted as base64 encoded attachments (or any other
324 encoding which ensures that the patch will not be trashed during
325 transmission) to the
326 @uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel}
327 mailing list.
328
329 It also helps quite a bit if you tell us what the patch does (for example
330 'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant
331 and has no lrint()'). This kind of explanation should be the body of the
332 commit message.
333
334 Also please if you send several patches, send each patch as a separate mail,
335 do not attach several unrelated patches to the same mail.
336
337 Use @code{git send-email} when possible since it will properly send patches
338 without requiring extra care.
339
340 Your patch will be reviewed on the mailing list. You will likely be asked
341 to make some changes and are expected to send in an improved version that
342 incorporates the requests from the review. This process may go through
343 several iterations. Once your patch is deemed good enough, it will be
344 committed to the official Libav tree.
345
346 Give us a few days to react. But if some time passes without reaction,
347 send a reminder by email. Your patch should eventually be dealt with.
348
349
350 @section New codecs or formats checklist
351
352 @enumerate
353 @item
354     Did you use av_cold for codec initialization and close functions?
355 @item
356     Did you add a long_name under NULL_IF_CONFIG_SMALL to the AVCodec or
357     AVInputFormat/AVOutputFormat struct?
358 @item
359     Did you bump the minor version number (and reset the micro version
360     number) in @file{libavcodec/version.h} or @file{libavformat/version.h}?
361 @item
362     Did you register it in @file{allcodecs.c} or @file{allformats.c}?
363 @item
364     Did you add the CodecID to @file{avcodec.h}?
365 @item
366     If it has a fourcc, did you add it to @file{libavformat/riff.c},
367     even if it is only a decoder?
368 @item
369     Did you add a rule to compile the appropriate files in the Makefile?
370     Remember to do this even if you are just adding a format to a file that
371     is already being compiled by some other rule, like a raw demuxer.
372 @item
373     Did you add an entry to the table of supported formats or codecs in
374     @file{doc/general.texi}?
375 @item
376     Did you add an entry in the Changelog?
377 @item
378     If it depends on a parser or a library, did you add that dependency in
379     configure?
380 @item
381     Did you @code{git add} the appropriate files before committing?
382 @item
383     Did you make sure it compiles standalone, i.e. with
384     @code{configure --disable-everything --enable-decoder=foo}
385     (or @code{--enable-demuxer} or whatever your component is)?
386 @end enumerate
387
388
389 @section patch submission checklist
390
391 @enumerate
392 @item
393     Does @code{make fate} pass with the patch applied?
394 @item
395     Does @code{make checkheaders} pass with the patch applied?
396 @item
397     Is the patch against latest Libav git master branch?
398 @item
399     Are you subscribed to the
400     @uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel}
401     mailing list? (Only list subscribers are allowed to post.)
402 @item
403     Have you checked that the changes are minimal, so that the same cannot be
404     achieved with a smaller patch and/or simpler final code?
405 @item
406     If the change is to speed critical code, did you benchmark it?
407 @item
408     If you did any benchmarks, did you provide them in the mail?
409 @item
410     Have you checked that the patch does not introduce buffer overflows or
411     other security issues?
412 @item
413     Did you test your decoder or demuxer against damaged data? If no, see
414     tools/trasher and the noise bitstream filter. Your decoder or demuxer
415     should not crash or end in a (near) infinite loop when fed damaged data.
416 @item
417     Does the patch not mix functional and cosmetic changes?
418 @item
419     Did you add tabs or trailing whitespace to the code? Both are forbidden.
420 @item
421     Is the patch attached to the email you send?
422 @item
423     Is the mime type of the patch correct? It should be text/x-diff or
424     text/x-patch or at least text/plain and not application/octet-stream.
425 @item
426     If the patch fixes a bug, did you provide a verbose analysis of the bug?
427 @item
428     If the patch fixes a bug, did you provide enough information, including
429     a sample, so the bug can be reproduced and the fix can be verified?
430     Note please do not attach samples >100k to mails but rather provide a
431     URL, you can upload to ftp://upload.libav.org
432 @item
433     Did you provide a verbose summary about what the patch does change?
434 @item
435     Did you provide a verbose explanation why it changes things like it does?
436 @item
437     Did you provide a verbose summary of the user visible advantages and
438     disadvantages if the patch is applied?
439 @item
440     Did you provide an example so we can verify the new feature added by the
441     patch easily?
442 @item
443     If you added a new file, did you insert a license header? It should be
444     taken from Libav, not randomly copied and pasted from somewhere else.
445 @item
446     You should maintain alphabetical order in alphabetically ordered lists as
447     long as doing so does not break API/ABI compatibility.
448 @item
449     Lines with similar content should be aligned vertically when doing so
450     improves readability.
451 @end enumerate
452
453 @section Patch review process
454
455 All patches posted to the
456 @uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel}
457 mailing list 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 When resubmitting patches, if their size grew or during the review different
472 issues arisen please split the patch so each issue has a specific patch.
473
474 @anchor{Regression Tests}
475 @section Regression Tests
476
477 Before submitting a patch (or committing to the repository), you should at
478 least make sure that it does not break anything.
479
480 If the code changed has already a test present in FATE you should run it,
481 otherwise it is advised to add it.
482
483 Improvements to codec or demuxer might change the FATE results. Make sure
484 to commit the update reference with the change and to explain in the comment
485 why the expected result changed.
486
487 Please refer to @file{doc/fate.txt}.
488
489 @bye