[FFmpeg-cvslog] doc/muxers/chromaprint: review and extend

Stefano Sabatini git at videolan.org
Sat Jan 20 14:04:39 EET 2024


ffmpeg | branch: master | Stefano Sabatini <stefasab at gmail.com> | Tue Jan 16 00:41:11 2024 +0100| [0726709e6d465c1206996eb9ac507ea924954d79] | committer: Stefano Sabatini

doc/muxers/chromaprint: review and extend

In particular, apply formatting and consistency fixes and sort options
by name.

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=0726709e6d465c1206996eb9ac507ea924954d79
---

 doc/muxers.texi | 43 +++++++++++++++++++++++--------------------
 1 file changed, 23 insertions(+), 20 deletions(-)

diff --git a/doc/muxers.texi b/doc/muxers.texi
index 1bdd7d34d5..256125d33a 100644
--- a/doc/muxers.texi
+++ b/doc/muxers.texi
@@ -884,41 +884,44 @@ It accepts a single audio stream.
 
 @anchor{chromaprint}
 @section chromaprint
+Chromaprint fingerprinter muxers.
 
-Chromaprint fingerprinter.
+To enable compilation of this filter you need to configure FFmpeg with
+ at 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:
+ at 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
- at 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.
-
- at item algorithm
-Version of algorithm to fingerprint with. Range is 0 to 4.
-Version 3 enables silence detection. Default is 1.
+ at item algorithm @var{version}
+Select version of algorithm to fingerprint with. Range is @code{0} to
+ at code{4}. Version @code{3} enables silence detection. Default is @code{1}.
 
- at item fp_format
+ at item fp_format @var{format}
 Format to output the fingerprint as. Accepts the following options:
 @table @samp
- at item raw
-Binary raw fingerprint
+ at item base64
+Base64 compressed fingerprint @emph{(default)}
 
 @item compressed
 Binary compressed fingerprint
 
- at item base64
-Base64 compressed fingerprint @emph{(default)}
-
+ at item raw
+Binary raw fingerprint
 @end table
 
+ at item silence_threshold @var{threshold}
+Threshold for detecting silence. Range is from @code{-1} to
+ at 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}



More information about the ffmpeg-cvslog mailing list