[FFmpeg-trac] #10767(documentation:new): Bad documentation on chroma-derived-nc and friends

FFmpeg trac at avcodec.org
Sun Dec 31 09:47:52 EET 2023


#10767: Bad documentation on chroma-derived-nc and friends
-------------------------------------+-------------------------------------
             Reporter:  Mingye Wang  |                     Type:  defect
               Status:  new          |                 Priority:  normal
            Component:               |                  Version:  git-
  documentation                      |  master
             Keywords:  colorspace   |               Blocked By:
             Blocking:               |  Reproduced by developer:  0
Analyzed by developer:  0            |
-------------------------------------+-------------------------------------
 Summary of the bug:
 The texinfo documentation on chroma-derived-{nc,c} is bad. In fact, it's
 worse than what we have in pixfmt.h. We should replace these all with
 pixfmt.h documentation.

 How to reproduce:
 Navigate to:
 * https://github.com/FFmpeg/FFmpeg/blob/master/libavutil/pixfmt.h, for how
 the documentation should look like.
 * https://ffmpeg.org/ffmpeg-codecs.html#Codec-Options, which has one
 instance of these options. Here we see {{{chroma-derived-nc}}} explained
 as "Chroma-derived NCL", which is very unhelpful compared to what pixfmt
 says. In general, the descriptions for {{{color_primaries}}},
 {{{color_trc}}}, and {{{colorspace}}} are of lower quality than their
 pixfmt.h version, so I recommend that they all be replaced.
 * https://ffmpeg.org/ffmpeg-filters.html#setparams-1, which has another
 instance. This one is just blank.
-- 
Ticket URL: <https://trac.ffmpeg.org/ticket/10767>
FFmpeg <https://ffmpeg.org>
FFmpeg issue tracker


More information about the FFmpeg-trac mailing list