issue_tracker.txt 6.07 KB
Newer Older
1
FFmpeg's bug/feature request tracker manual
2
=================================================
3 4 5

Overview:
---------
6

7 8
FFmpeg uses Trac for tracking issues, new issues and changes to
existing issues can be done through a web interface.
9

10 11
Issues can be different kinds of things we want to keep track of
but that do not belong into the source tree itself. This includes
12
bug reports, feature requests and license violations. We
13 14 15 16
might add more items to this list in the future, so feel free to
propose a new `type of issue' on the ffmpeg-devel mailing list if
you feel it is worth tracking.

17
It is possible to subscribe to individual issues by adding yourself to the
18 19
Cc list or to subscribe to the ffmpeg-trac mailing list which receives
a mail for every change to every issue.
20
(the above does all work already after light testing)
21

22
The subscription URL for the ffmpeg-trac list is:
23
https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-trac
24
The URL of the webinterface of the tracker is:
25
https://trac.ffmpeg.org
26 27 28

Type:
-----
29 30 31
art
    Artwork such as photos, music, banners, and logos.

32
bug / defect
Diego Biurrun's avatar
Diego Biurrun committed
33
    An error, flaw, mistake, failure, or fault in FFmpeg or libav* that
34 35
    prevents it from behaving as intended.

36
feature request / enhancement
37 38
    Request of support for encoding or decoding of a new codec, container
    or variant.
39
    Request of support for more, less or plain different output or behavior
Diego Biurrun's avatar
Diego Biurrun committed
40
    where the current implementation cannot be considered wrong.
41

42
license violation
43
    Ticket to keep track of (L)GPL violations of ffmpeg by others.
44

45 46 47
sponsoring request
    Developer requests for hardware, software, specifications, money,
    refunds, etc.
48

49 50 51 52
task
    A task/reminder such as setting up a FATE client, adding filters to
    Trac, etc.

53 54 55
Priority:
---------
critical
56
    Bugs about data loss and security issues.
57
    No feature request can be critical.
58 59

important
60
    Bugs which make FFmpeg unusable for a significant number of users.
Diego Biurrun's avatar
Diego Biurrun committed
61
    Examples here might be completely broken MPEG-4 decoding or a build issue
62
    on Linux.
Diego Biurrun's avatar
Diego Biurrun committed
63 64
    While broken 4xm decoding or a broken OS/2 build would not be important,
    the separation to normal is somewhat fuzzy.
65 66
    For feature requests this priority would be used for things many people
    want.
67
    Regressions also should be marked as important, regressions are bugs that
68
    don't exist in a past revision or another branch.
69 70

normal
71 72
   Default setting. Use this if the bug does not match the other
   priorities or if you are unsure of what priority to choose.
73 74

minor
75
    Bugs about things like spelling errors, "mp2" instead of
76 77
    "mp3" being shown and such.
    Feature requests about things few people want or which do not make a big
78 79 80
    difference.

wish
Luca Barbato's avatar
Luca Barbato committed
81
    Something that is desirable to have but that there is no urgency at
Diego Biurrun's avatar
Diego Biurrun committed
82
    all to implement, e.g. something completely cosmetic like a website
83
    restyle or a personalized doxy template or the FFmpeg logo.
Diego Biurrun's avatar
Diego Biurrun committed
84
    This priority is not valid for bugs.
85 86 87 88 89 90 91 92 93 94 95


Status:
-------
new
    initial state

open
    intermediate states

closed
Diego Biurrun's avatar
Diego Biurrun committed
96
    final state
97 98


99 100 101 102 103 104 105 106 107 108 109
Analyzed flag:
--------------
Bugs which have been analyzed and where it is understood what causes them
and which exact chain of events triggers them. This analysis should be
available as a message in the bug report.
Note, do not change the status to analyzed without also providing a clear
and understandable analysis.
This state implicates that the bug either has been reproduced or that
reproduction is not needed as the bug is already understood.


110
Type/Status:
111
----------
112
*/new
113
    Initial state of new bugs and feature requests submitted by
Diego Biurrun's avatar
Diego Biurrun committed
114
    users.
115

116
*/open
117 118
    Issues which have been briefly looked at and which did not look outright
    invalid.
Diego Biurrun's avatar
Diego Biurrun committed
119 120
    This implicates that no real more detailed state applies yet. Conversely,
    the more detailed states below implicate that the issue has been briefly
121 122 123
    looked at.

*/closed/duplicate
124
    Bugs or feature requests which are duplicates.
Diego Biurrun's avatar
Diego Biurrun committed
125 126
    Note, if you mark something as duplicate, do not forget setting the
    superseder so bug reports are properly linked.
127 128

*/closed/invalid
Diego Biurrun's avatar
Diego Biurrun committed
129
    Bugs caused by user errors, random ineligible or otherwise nonsense stuff.
130

131 132 133 134
*/closed/needs_more_info
    Issues for which some information has been requested by the developers,
    but which has not been provided by anyone within reasonable time.

135 136 137 138

bug/closed/fixed
    Bugs which have to the best of our knowledge been fixed.

139
bug/closed/wontfix
140 141 142
    Bugs which we will not fix. Possible reasons include legality, high
    complexity for the sake of supporting obscure corner cases, speed loss
    for similarly esoteric purposes, et cetera.
143
    This also means that we would reject a patch.
144
    If we are just too lazy to fix a bug then the correct state is open
145 146
    and unassigned. Closed means that the case is closed which is not
    the case if we are just waiting for a patch.
147 148 149

bug/closed/works_for_me
    Bugs for which sufficient information was provided to reproduce but
150
    reproduction failed - that is the code seems to work correctly to the
Luca Barbato's avatar
Luca Barbato committed
151
    best of our knowledge.
152

153
feature_request/closed/fixed
154 155
    Feature requests which have been implemented.

156
feature_request/closed/wontfix
Luca Barbato's avatar
Luca Barbato committed
157
    Feature requests which will not be implemented. The reasons here could
158 159
    be legal, philosophical or others.

Diego Biurrun's avatar
Diego Biurrun committed
160
Note2, if you provide the requested info do not forget to remove the
161
needs_more_info resolution.
162

163 164
Component:
----------
Michael Niedermayer's avatar
Michael Niedermayer committed
165 166 167 168

avcodec
    issues in libavcodec/*

169 170 171 172 173 174
avdevice
    issues in libavdevice/*

avfilter
    issues in libavfilter/*

Michael Niedermayer's avatar
Michael Niedermayer committed
175 176 177 178 179 180
avformat
    issues in libavformat/*

avutil
    issues in libavutil/*

181 182 183 184 185
build system
    issues in or related to configure/Makefile

documentation
    issues in or related to doc/*
Michael Niedermayer's avatar
Michael Niedermayer committed
186 187 188 189 190 191 192

ffmpeg
    issues in or related to ffmpeg.c

ffplay
    issues in or related to ffplay.c

193 194 195
ffprobe
    issues in or related to ffprobe.c

Michael Niedermayer's avatar
Michael Niedermayer committed
196 197 198
ffserver
    issues in or related to ffserver.c

199 200 201 202 203
postproc
    issues in libpostproc/*

swresample
    issues in libswresample/*
Michael Niedermayer's avatar
Michael Niedermayer committed
204

205 206
swscale
    issues in libswscale/*
Michael Niedermayer's avatar
Michael Niedermayer committed
207

208
trac
Michael Niedermayer's avatar
Michael Niedermayer committed
209
    issues related to our issue tracker
210 211 212 213 214 215 216 217 218

undetermined
    default component; choose this if unsure

website
    issues related to the website

wiki
    issues related to the wiki