[FFmpeg-trac] #10330(documentation:new): Opus documentation: lowdelay is too trivialized

[FFmpeg]

#10330: Opus documentation: lowdelay is too trivialized
-------------------------------------+-------------------------------------
             Reporter:  Mingye Wang  |                    Owner:  (none)
                 Type:  defect       |                   Status:  new
             Priority:  normal       |                Component:
                                     |  documentation
              Version:  unspecified  |               Resolution:
             Keywords:  libopus      |               Blocked By:
  docs                               |
             Blocking:               |  Reproduced by developer:  0
Analyzed by developer:  0            |
-------------------------------------+-------------------------------------
Description changed by Mingye Wang:

Old description:

> Summary of the bug:
>
> FFmpeg currently describes (at https://ffmpeg.org/ffmpeg-
> codecs.html#libopus-1) `-application lowdelay` as simply "Restrict to
> only the lowest delay modes." This is true, but does not cover the whole
> picture. Compare the [[https://www.opus-
> codec.org/docs/html_api/group__ctlvalues.html#ga592232fb39db60c1369989c5c5d19a07|Official
> documentation of OPUS_APPLICATION_RESTRICTED_LOWDELAY]]: "Only use when
> lowest-achievable latency is what matters most. Voice-optimized modes
> cannot be used."
>
> A better wording based on the above would be:
> "Restrict to only the lowest delay modes by disabling voice-optimized
> codec. This is usually unnecessary, as basic Opus already has a delay of
> 22.5 ms. Try -frame_duration before using this."
>
> How to reproduce:
> Well, just navigate to the page. Or
> {{{
> ffmpeg -h enccoder=libopus
> }}}

New description:

 Summary of the bug:

 FFmpeg currently describes (at https://ffmpeg.org/ffmpeg-
 codecs.html#libopus-1) `-application lowdelay` as simply "Restrict to only
 the lowest delay modes." This is true, but does not cover the whole
 picture. Compare the [[https://www.opus-
 codec.org/docs/html_api/group__ctlvalues.html#ga592232fb39db60c1369989c5c5d19a07|Official
 documentation of OPUS_APPLICATION_RESTRICTED_LOWDELAY]]: "Only use when
 lowest-achievable latency is what matters most. Voice-optimized modes
 cannot be used."

 A better wording based on the above would be:
 "Restrict to only the lowest delay modes by disabling voice-optimized
 codec. This is usually unnecessary, as basic Opus already has a delay of
 26.5 ms. Try -frame_duration before using this."

 How to reproduce:
 Well, just navigate to the page. Or
 {{{
 ffmpeg -h enccoder=libopus
 }}}

--
-- 
Ticket URL: <https://trac.ffmpeg.org/ticket/10330#comment:3>
FFmpeg <https://ffmpeg.org>
FFmpeg issue tracker