diff mbox series

[FFmpeg-devel,3/3] doc/muxers/chromaprint: review and extend

Message ID 20240115235732.525460-3-stefasab@gmail.com
State New
Headers show
Series [FFmpeg-devel,1/3] doc/muxers: add caf | expand

Checks

Context Check Description
yinshiyou/configure_loongarch64 warning Failed to apply patch
andriy/configure_x86 warning Failed to apply patch

Commit Message

Stefano Sabatini Jan. 15, 2024, 11:57 p.m. UTC 
In particular, apply formatting and consistency fixes and sort options
by name.
---
 doc/muxers.texi | 45 ++++++++++++++++++++++++---------------------
 1 file changed, 24 insertions(+), 21 deletions(-)

Comments

Stefano Sabatini Jan. 20, 2024, 11:41 a.m. UTC | #1 
On date Tuesday 2024-01-16 00:57:32 +0100, Stefano Sabatini wrote:
> In particular, apply formatting and consistency fixes and sort options
> by name.
> ---
>  doc/muxers.texi | 45 ++++++++++++++++++++++++---------------------
>  1 file changed, 24 insertions(+), 21 deletions(-)

Will apply this and the other pending doc/muxers patches.
diff mbox series

Patch

diff --git a/doc/muxers.texi b/doc/muxers.texi
index eadcba690c..5e4ee40db4 100644
--- a/doc/muxers.texi
+++ b/doc/muxers.texi
@@ -889,41 +889,44 @@  It accepts a single codec2 audio stream.
 
 @anchor{chromaprint}
 @section chromaprint
+Chromaprint fingerprinter muxers.
 
-Chromaprint fingerprinter.
+To enable compilation of this filter you need to configure FFmpeg with
+@code{--enable-chromaprint}.
 
-This muxer feeds audio data to the Chromaprint library,
-which generates a fingerprint for the provided audio data. See @url{https://acoustid.org/chromaprint}
+This muxer feeds audio data to the Chromaprint library, which
+generates a fingerprint for the provided audio data. See:
+@url{https://acoustid.org/chromaprint}
 
-It takes a single signed native-endian 16-bit raw audio stream of at most 2 channels.
+It takes a single signed native-endian 16-bit raw audio stream of at
+most 2 channels.
 
 @subsection Options
-
 @table @option
-@item silence_threshold
-Threshold for detecting silence. Range is from -1 to 32767, where -1 disables
-silence detection. Silence detection can only be used with version 3 of the
-algorithm.
-Silence detection must be disabled for use with the AcoustID service. Default is -1.
-
-@item algorithm
-Version of algorithm to fingerprint with. Range is 0 to 4.
-Version 3 enables silence detection. Default is 1.
+@item algorithm @var{version}
+Select version of algorithm to fingerprint with. Range is @code{0} to
+@code{4}. Version @code{3} enables silence detection. Default is @code{1}.
 
-@item fp_format
+@item fp_format @var{format}
 Format to output the fingerprint as. Accepts the following options:
-@table @samp
-@item raw
-Binary raw fingerprint
+@item base64
+Base64 compressed fingerprint @emph{(default)}
 
 @item compressed
 Binary compressed fingerprint
 
-@item base64
-Base64 compressed fingerprint @emph{(default)}
-
+@table @samp
+@item raw
+Binary raw fingerprint
 @end table
 
+@item silence_threshold @var{threshold}
+Threshold for detecting silence. Range is from @code{-1} to
+@code{32767}, where @code{-1} disables silence detection. Silence
+detection can only be used with version @code{3} of the algorithm.
+
+Silence detection must be disabled for use with the AcoustID
+service. Default is @code{-1}.
 @end table
 
 @anchor{crc}