doc/developer: Clarify symbol naming prefixes section.
[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 between 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 Do not check for NULL values by comparison, @samp{if (p)} and
77 @samp{if (!p)} are correct; @samp{if (p == NULL)} and @samp{if (p != NULL)}
78 are not.
79 @item
80 In case of a single-statement if, no curly braces are required:
81 @example
82 if (!pic || !picref)
83     goto fail;
84 @end example
85 @item
86 Do not put spaces immediately inside parentheses. @samp{if (ret)} is
87 a valid style; @samp{if ( ret )} is not.
88 @end itemize
89
90 There are the following guidelines regarding the indentation in files:
91 @itemize @bullet
92 @item
93 Indent size is 4.
94 @item
95 The TAB character is forbidden outside of Makefiles as is any
96 form of trailing whitespace. Commits containing either will be
97 rejected by the git repository.
98 @item
99 You should try to limit your code lines to 80 characters; however, do so if
100 and only if this improves readability.
101 @end itemize
102 The presentation is one inspired by 'indent -i4 -kr -nut'.
103
104 The main priority in Libav is simplicity and small code size in order to
105 minimize the bug count.
106
107 @subsection Comments
108 Use the JavaDoc/Doxygen  format (see examples below) so that code documentation
109 can be generated automatically. All nontrivial functions should have a comment
110 above them explaining what the function does, even if it is just one sentence.
111 All structures and their member variables should be documented, too.
112
113 Avoid Qt-style and similar Doxygen syntax with @code{!} in it, i.e. replace
114 @code{//!} with @code{///} and similar.  Also @@ syntax should be employed
115 for markup commands, i.e. use @code{@@param} and not @code{\param}.
116
117 @example
118 /**
119  * @@file
120  * MPEG codec.
121  * @@author ...
122  */
123
124 /**
125  * Summary sentence.
126  * more text ...
127  * ...
128  */
129 typedef struct Foobar@{
130     int var1; /**< var1 description */
131     int var2; ///< var2 description
132     /** var3 description */
133     int var3;
134 @} Foobar;
135
136 /**
137  * Summary sentence.
138  * more text ...
139  * ...
140  * @@param my_parameter description of my_parameter
141  * @@return return value description
142  */
143 int myfunc(int my_parameter)
144 ...
145 @end example
146
147 @subsection C language features
148
149 Libav is programmed in the ISO C90 language with a few additional
150 features from ISO C99, namely:
151 @itemize @bullet
152 @item
153 the @samp{inline} keyword;
154 @item
155 @samp{//} comments;
156 @item
157 designated struct initializers (@samp{struct s x = @{ .i = 17 @};})
158 @item
159 compound literals (@samp{x = (struct s) @{ 17, 23 @};})
160 @end itemize
161
162 These features are supported by all compilers we care about, so we will not
163 accept patches to remove their use unless they absolutely do not impair
164 clarity and performance.
165
166 All code must compile with recent versions of GCC and a number of other
167 currently supported compilers. To ensure compatibility, please do not use
168 additional C99 features or GCC extensions. Especially watch out for:
169 @itemize @bullet
170 @item
171 mixing statements and declarations;
172 @item
173 @samp{long long} (use @samp{int64_t} instead);
174 @item
175 @samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar;
176 @item
177 GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
178 @end itemize
179
180 @subsection Naming conventions
181 All names should be composed with underscores (_), not CamelCase. For example,
182 @samp{avfilter_get_video_buffer} is an acceptable function name and
183 @samp{AVFilterGetVideo} is not. The only exception are structure
184 names; they should always be CamelCase.
185
186 There are the following conventions for naming variables and functions:
187 @itemize @bullet
188 @item
189 For local variables no prefix is required.
190 @item
191 For file-scope variables and functions declared as @code{static}, no prefix
192 is required.
193 @item
194 For variables and functions visible outside of file scope, but only used
195 internally by a library, an @code{ff_} prefix should be used,
196 e.g. @samp{ff_w64_demuxer}.
197 @item
198 For variables and functions visible outside of file scope, used internally
199 across multiple libraries, use @code{avpriv_} as prefix, for example,
200 @samp{avpriv_aac_parse_header}.
201 @item
202 For externally visible symbols, each library has its own prefix. Check
203 the existing code and choose names accordingly.
204 @end itemize
205
206 Furthermore, name space reserved for the system should not be invaded.
207 Identifiers ending in @code{_t} are reserved by
208 @url{http://pubs.opengroup.org/onlinepubs/007904975/functions/xsh_chap02_02.html#tag_02_02_02, POSIX}.
209 Also avoid names starting with @code{__} or @code{_} followed by an uppercase
210 letter as they are reserved by the C standard. Names starting with @code{_}
211 are reserved at the file level and may not be used for externally visible
212 symbols. If in doubt, just avoid names starting with @code{_} altogether.
213
214 @subsection Miscellaneous conventions
215 @itemize @bullet
216 @item
217 fprintf and printf are forbidden in libavformat and libavcodec,
218 please use av_log() instead.
219 @item
220 Casts should be used only when necessary. Unneeded parentheses
221 should also be avoided if they don't make the code easier to understand.
222 @end itemize
223
224 @subsection Editor configuration
225 In order to configure Vim to follow Libav formatting conventions, paste
226 the following snippet into your @file{.vimrc}:
227 @example
228 " Indentation rules for Libav: 4 spaces, no tabs.
229 set expandtab
230 set shiftwidth=4
231 set softtabstop=4
232 set cindent
233 set cinoptions=(0
234 " Allow tabs in Makefiles.
235 autocmd FileType make,automake set noexpandtab shiftwidth=8 softtabstop=8
236 " Trailing whitespace and tabs are forbidden, so highlight them.
237 highlight ForbiddenWhitespace ctermbg=red guibg=red
238 match ForbiddenWhitespace /\s\+$\|\t/
239 " Do not highlight spaces at the end of line while typing on that line.
240 autocmd InsertEnter * match ForbiddenWhitespace /\t\|\s\+\%#\@@<!$/
241 @end example
242
243 For Emacs, add these roughly equivalent lines to your @file{.emacs.d/init.el}:
244 @example
245 (c-add-style "libav"
246              '("k&r"
247                (c-basic-offset . 4)
248                (indent-tabs-mode . nil)
249                (show-trailing-whitespace . t)
250                (c-offsets-alist
251                 (statement-cont . (c-lineup-assignments +)))
252                )
253              )
254 (setq c-default-style "libav")
255 @end example
256
257 @section Development Policy
258
259 @enumerate
260 @item
261    Contributions should be licensed under the
262    @uref{http://www.gnu.org/licenses/lgpl-2.1.html, LGPL 2.1},
263    including an "or any later version" clause, or, if you prefer
264    a gift-style license, the
265    @uref{http://www.isc.org/software/license/, ISC} or
266    @uref{http://mit-license.org/, MIT} license.
267    @uref{http://www.gnu.org/licenses/gpl-2.0.html, GPL 2} including
268    an "or any later version" clause is also acceptable, but LGPL is
269    preferred.
270 @item
271    All the patches MUST be reviewed in the mailing list before they are
272    committed.
273 @item
274    The Libav coding style should remain consistent. Changes to
275    conform will be suggested during the review or implemented on commit.
276 @item
277    Patches should be generated using @code{git format-patch} or directly sent
278    using @code{git send-email}.
279    Please make sure you give the proper credit by setting the correct author
280    in the commit.
281 @item
282    The commit message should have a short first line in the form of
283    a @samp{topic: short description} as a header, separated by a newline
284    from the body consisting of an explanation of why the change is necessary.
285    If the commit fixes a known bug on the bug tracker, the commit message
286    should include its bug ID. Referring to the issue on the bug tracker does
287    not exempt you from writing an excerpt of the bug in the commit message.
288    If the patch is a bug fix which should be backported to stable releases,
289    i.e. a non-API/ABI-breaking bug fix, add @code{CC: libav-stable@@libav.org}
290    to the bottom of your commit message, and make sure to CC your patch to
291    this address, too. Some git setups will do this automatically.
292 @item
293    Work in progress patches should be sent to the mailing list with the [WIP]
294    or the [RFC] tag.
295 @item
296    Branches in public personal repos are advised as way to
297    work on issues collaboratively.
298 @item
299    You do not have to over-test things. If it works for you and you think it
300    should work for others, send it to the mailing list for review.
301    If you have doubt about portability please state it in the submission so
302    people with specific hardware could test it.
303 @item
304    Do not commit unrelated changes together, split them into self-contained
305    pieces. Also do not forget that if part B depends on part A, but A does not
306    depend on B, then A can and should be committed first and separate from B.
307    Keeping changes well split into self-contained parts makes reviewing and
308    understanding them on the commit log mailing list easier. This also helps
309    in case of debugging later on.
310 @item
311    Patches that change behavior of the programs (renaming options etc) or
312    public API or ABI should be discussed in depth and possible few days should
313    pass between discussion and commit.
314    Changes to the build system (Makefiles, configure script) which alter
315    the expected behavior should be considered in the same regard.
316 @item
317    When applying patches that have been discussed (at length) on the mailing
318    list, reference the thread in the log message.
319 @item
320     Subscribe to the
321     @uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel} and
322     @uref{https://lists.libav.org/mailman/listinfo/libav-commits, libav-commits}
323     mailing lists.
324     Bugs and possible improvements or general questions regarding commits
325     are discussed on libav-devel. We expect you to react if problems with
326     your code are uncovered.
327 @item
328     Update the documentation if you change behavior or add features. If you are
329     unsure how best to do this, send an [RFC] patch to libav-devel.
330 @item
331     All discussions and decisions should be reported on the public developer
332     mailing list, so that there is a reference to them.
333     Other media (e.g. IRC) should be used for coordination and immediate
334     collaboration.
335 @item
336     Never write to unallocated memory, never write over the end of arrays,
337     always check values read from some untrusted source before using them
338     as array index or other risky things. Always use valgrind to double-check.
339 @item
340     Remember to check if you need to bump versions for the specific libav
341     parts (libavutil, libavcodec, libavformat) you are changing. You need
342     to change the version integer.
343     Incrementing the first component means no backward compatibility to
344     previous versions (e.g. removal of a function from the public API).
345     Incrementing the second component means backward compatible change
346     (e.g. addition of a function to the public API or extension of an
347     existing data structure).
348     Incrementing the third component means a noteworthy binary compatible
349     change (e.g. encoder bug fix that matters for the decoder).
350 @item
351     Compiler warnings indicate potential bugs or code with bad style.
352     If it is a bug, the bug has to be fixed. If it is not, the code should
353     be changed to not generate a warning unless that causes a slowdown
354     or obfuscates the code.
355     If a type of warning leads to too many false positives, that warning
356     should be disabled, not the code changed.
357 @item
358     If you add a new file, give it a proper license header. Do not copy and
359     paste it from a random place, use an existing file as template.
360 @end enumerate
361
362 We think our rules are not too hard. If you have comments, contact us.
363
364 @section Submitting patches
365
366 First, read the @ref{Coding Rules} above if you did not yet, in particular
367 the rules regarding patch submission.
368
369 As stated already, please do not submit a patch which contains several
370 unrelated changes.
371 Split it into separate, self-contained pieces. This does not mean splitting
372 file by file. Instead, make the patch as small as possible while still
373 keeping it as a logical unit that contains an individual change, even
374 if it spans multiple files. This makes reviewing your patches much easier
375 for us and greatly increases your chances of getting your patch applied.
376
377 Use the patcheck tool of Libav to check your patch.
378 The tool is located in the tools directory.
379
380 Run the @ref{Regression Tests} before submitting a patch in order to verify
381 it does not cause unexpected problems.
382
383 It also helps quite a bit if you tell us what the patch does (for example
384 'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant
385 and has no lrint()'). This kind of explanation should be the body of the
386 commit message.
387
388 Also please if you send several patches, send each patch as a separate mail,
389 do not attach several unrelated patches to the same mail.
390
391 Patches should be posted to the
392 @uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel}
393 mailing list. Use @code{git send-email} when possible since it will properly
394 send patches without requiring extra care. If you cannot, then send patches
395 as base64-encoded attachments, so your patch is not trashed during
396 transmission.
397
398 Your patch will be reviewed on the mailing list. You will likely be asked
399 to make some changes and are expected to send in an improved version that
400 incorporates the requests from the review. This process may go through
401 several iterations. Once your patch is deemed good enough, it will be
402 committed to the official Libav tree.
403
404 Give us a few days to react. But if some time passes without reaction,
405 send a reminder by email. Your patch should eventually be dealt with.
406
407
408 @section New codecs or formats checklist
409
410 @enumerate
411 @item
412     Did you use av_cold for codec initialization and close functions?
413 @item
414     Did you add a long_name under NULL_IF_CONFIG_SMALL to the AVCodec or
415     AVInputFormat/AVOutputFormat struct?
416 @item
417     Did you bump the minor version number (and reset the micro version
418     number) in @file{libavcodec/version.h} or @file{libavformat/version.h}?
419 @item
420     Did you register it in @file{allcodecs.c} or @file{allformats.c}?
421 @item
422     Did you add the AVCodecID to @file{avcodec.h}?
423     When adding new codec IDs, also add an entry to the codec descriptor
424     list in @file{libavcodec/codec_desc.c}.
425 @item
426     If it has a FourCC, did you add it to @file{libavformat/riff.c},
427     even if it is only a decoder?
428 @item
429     Did you add a rule to compile the appropriate files in the Makefile?
430     Remember to do this even if you are just adding a format to a file that
431     is already being compiled by some other rule, like a raw demuxer.
432 @item
433     Did you add an entry to the table of supported formats or codecs in
434     @file{doc/general.texi}?
435 @item
436     Did you add an entry in the Changelog?
437 @item
438     If it depends on a parser or a library, did you add that dependency in
439     configure?
440 @item
441     Did you @code{git add} the appropriate files before committing?
442 @item
443     Did you make sure it compiles standalone, i.e. with
444     @code{configure --disable-everything --enable-decoder=foo}
445     (or @code{--enable-demuxer} or whatever your component is)?
446 @end enumerate
447
448
449 @section patch submission checklist
450
451 @enumerate
452 @item
453     Does @code{make check} pass with the patch applied?
454 @item
455     Is the patch against latest Libav git master branch?
456 @item
457     Are you subscribed to the
458     @uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel}
459     mailing list? (Only list subscribers are allowed to post.)
460 @item
461     Have you checked that the changes are minimal, so that the same cannot be
462     achieved with a smaller patch and/or simpler final code?
463 @item
464     If the change is to speed critical code, did you benchmark it?
465 @item
466     If you did any benchmarks, did you provide them in the mail?
467 @item
468     Have you checked that the patch does not introduce buffer overflows or
469     other security issues?
470 @item
471     Did you test your decoder or demuxer against damaged data? If no, see
472     tools/trasher, the noise bitstream filter, and
473     @uref{http://caca.zoy.org/wiki/zzuf, zzuf}. Your decoder or demuxer
474     should not crash, end in a (near) infinite loop, or allocate ridiculous
475     amounts of memory when fed damaged data.
476 @item
477     Does the patch not mix functional and cosmetic changes?
478 @item
479     Did you add tabs or trailing whitespace to the code? Both are forbidden.
480 @item
481     Is the patch attached to the email you send?
482 @item
483     Is the mime type of the patch correct? It should be text/x-diff or
484     text/x-patch or at least text/plain and not application/octet-stream.
485 @item
486     If the patch fixes a bug, did you provide a verbose analysis of the bug?
487 @item
488     If the patch fixes a bug, did you provide enough information, including
489     a sample, so the bug can be reproduced and the fix can be verified?
490     Note please do not attach samples >100k to mails but rather provide a
491     URL, you can upload to ftp://upload.libav.org
492 @item
493     Did you provide a verbose summary about what the patch does change?
494 @item
495     Did you provide a verbose explanation why it changes things like it does?
496 @item
497     Did you provide a verbose summary of the user visible advantages and
498     disadvantages if the patch is applied?
499 @item
500     Did you provide an example so we can verify the new feature added by the
501     patch easily?
502 @item
503     If you added a new file, did you insert a license header? It should be
504     taken from Libav, not randomly copied and pasted from somewhere else.
505 @item
506     You should maintain alphabetical order in alphabetically ordered lists as
507     long as doing so does not break API/ABI compatibility.
508 @item
509     Lines with similar content should be aligned vertically when doing so
510     improves readability.
511 @item
512     Make sure you check the return values of function and return appropriate
513     error codes. Especially memory allocation functions like @code{malloc()}
514     are notoriously left unchecked, which is a serious problem.
515 @end enumerate
516
517 @section Patch review process
518
519 All patches posted to the
520 @uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel}
521 mailing list will be reviewed, unless they contain a
522 clear note that the patch is not for the git master branch.
523 Reviews and comments will be posted as replies to the patch on the
524 mailing list. The patch submitter then has to take care of every comment,
525 that can be by resubmitting a changed patch or by discussion. Resubmitted
526 patches will themselves be reviewed like any other patch. If at some point
527 a patch passes review with no comments then it is approved, that can for
528 simple and small patches happen immediately while large patches will generally
529 have to be changed and reviewed many times before they are approved.
530 After a patch is approved it will be committed to the repository.
531
532 We will review all submitted patches, but sometimes we are quite busy so
533 especially for large patches this can take several weeks.
534
535 When resubmitting patches, if their size grew or during the review different
536 issues arisen please split the patch so each issue has a specific patch.
537
538 @anchor{Regression Tests}
539 @section Regression Tests
540
541 Before submitting a patch (or committing to the repository), you should at
542 least make sure that it does not break anything.
543
544 If the code changed has already a test present in FATE you should run it,
545 otherwise it is advised to add it.
546
547 Improvements to codec or demuxer might change the FATE results. Make sure
548 to commit the update reference with the change and to explain in the comment
549 why the expected result changed.
550
551 Please refer to @url{fate.html}.
552
553 @anchor{Release process}
554 @section Release process
555
556 Libav maintains a set of @strong{release branches}, which are the
557 recommended deliverable for system integrators and distributors (such as
558 Linux distributions, etc.). At irregular times, a @strong{release
559 manager} prepares, tests and publishes tarballs on the
560 @url{http://libav.org} website.
561
562 There are two kinds of releases:
563
564 @enumerate
565 @item
566     @strong{Major releases} always include the latest and greatest
567     features and functionality.
568 @item
569     @strong{Point releases} are cut from @strong{release} branches,
570     which are named @code{release/X}, with @code{X} being the release
571     version number.
572 @end enumerate
573
574 Note that we promise to our users that shared libraries from any Libav
575 release never break programs that have been @strong{compiled} against
576 previous versions of @strong{the same release series} in any case!
577
578 However, from time to time, we do make API changes that require adaptations
579 in applications. Such changes are only allowed in (new) major releases and
580 require further steps such as bumping library version numbers and/or
581 adjustments to the symbol versioning file. Please discuss such changes
582 on the @strong{libav-devel} mailing list in time to allow forward planning.
583
584 @anchor{Criteria for Point Releases}
585 @subsection Criteria for Point Releases
586
587 Changes that match the following criteria are valid candidates for
588 inclusion into a point release:
589
590 @enumerate
591 @item
592     Fixes a security issue, preferably identified by a @strong{CVE
593     number} issued by @url{http://cve.mitre.org/}.
594 @item
595     Fixes a documented bug in @url{http://bugzilla.libav.org}.
596 @item
597     Improves the included documentation.
598 @item
599     Retains both source code and binary compatibility with previous
600     point releases of the same release branch.
601 @end enumerate
602
603 The order for checking the rules is (1 OR 2 OR 3) AND 4.
604
605 All Libav developers are welcome to nominate commits that they push to
606 @code{master} by mailing the @strong{libav-stable} mailing list. The
607 easiest way to do so is to include @code{CC: libav-stable@@libav.org} in
608 the commit message.
609
610
611 @subsection Release Checklist
612
613 The release process involves the following steps:
614
615 @enumerate
616 @item
617     Ensure that the @file{RELEASE} file contains the version number for
618     the upcoming release.
619 @item
620     File a release tracking bug in @url{http://bugzilla.libav.org}. Make
621     sure that the bug has an alias named @code{ReleaseX.Y} for the
622     @code{X.Y} release.
623 @item
624     Announce the intent to do a release to the mailing list.
625 @item
626     Reassign unresolved blocking bugs from previous release
627     tracking bugs to the new bug.
628 @item
629     Review patch nominations that reach the @strong{libav-stable}
630     mailing list, and push patches that fulfill the stable release
631     criteria to the release branch.
632 @item
633     Ensure that the FATE regression suite still passes in the release
634     branch on at least @strong{i386} and @strong{amd64}
635     (cf. @ref{Regression Tests}).
636 @item
637     Prepare the release tarballs in @code{xz} and @code{gz} formats, and
638     supplementing files that contain @code{md5} and @code{sha1}
639     checksums.
640 @item
641     Publish the tarballs at @url{http://libav.org/releases}. Create and
642     push an annotated tag in the form @code{vX}, with @code{X}
643     containing the version number.
644 @item
645     Build the tarballs with the Windows binaries, and publish them at
646     @url{http://win32.libav.org/releases}.
647 @item
648     Propose and send a patch to the @strong{libav-devel} mailing list
649     with a news entry for the website.
650 @item
651     Publish the news entry.
652 @item
653     Send announcement to the mailing list.
654 @end enumerate
655
656 @bye