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