From 8bd791969960d6258177ebf8b68391fd4b432fd1 Mon Sep 17 00:00:00 2001 From: Gyan Doshi Date: Tue, 4 Dec 2018 16:34:38 +0530 Subject: [PATCH] doc: chromaprint Add entry in external library list and add details to muxer entry. --- doc/general.texi | 6 ++++++ doc/muxers.texi | 18 ++++++++++-------- 2 files changed, 16 insertions(+), 8 deletions(-) diff --git a/doc/general.texi b/doc/general.texi index 5256e0653d..7b6efdbfdd 100644 --- a/doc/general.texi +++ b/doc/general.texi @@ -53,6 +53,12 @@ Go to @url{http://aomedia.org/} and follow the instructions for installing the library. Then pass @code{--enable-libaom} to configure to enable it. +@section Chromaprint + +FFmpeg can make use of the Chromaprint library for generating audio fingerprints. +It is licensed under LGPL version 2.1. Pass @code{--enable-chromaprint} to configure to +enable it. See @url{https://acoustid.org/chromaprint}. + @section OpenJPEG FFmpeg can use the OpenJPEG libraries for encoding/decoding J2K videos. Go to diff --git a/doc/muxers.texi b/doc/muxers.texi index f1cc6f5fee..5565fd5f45 100644 --- a/doc/muxers.texi +++ b/doc/muxers.texi @@ -94,21 +94,23 @@ compatibility with software that only supports a single audio stream in AVI @anchor{chromaprint} @section chromaprint -Chromaprint fingerprinter +Chromaprint fingerprinter. -This muxer feeds audio data to the Chromaprint library, which generates -a fingerprint for the provided audio data. It takes a single signed -native-endian 16-bit raw audio stream. +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. @subsection Options @table @option @item silence_threshold -Threshold for detecting silence, ranges from 0 to 32767. -1 for default -(required for use with the AcoustID service). +Threshold for detecting silence, ranges from -1 to 32767. -1 disables silence detection and +is required for use with the AcoustID service. Default is -1. @item algorithm -Algorithm index to fingerprint with. +Version of algorithm to fingerprint with. Range is 0 to 4. Version 2 requires that silence +detection be enabled. Default is 1. @item fp_format Format to output the fingerprint as. Accepts the following options: @@ -120,7 +122,7 @@ Binary raw fingerprint Binary compressed fingerprint @item base64 -Base64 compressed fingerprint +Base64 compressed fingerprint @emph{(default)} @end table