diff mbox

[FFmpeg-devel,v2,2/5] doc/formats: Update documentation for chromaprint

Message ID 20191006054950.30374-2-andriy.gelman@gmail.com
State New
Headers show

Commit Message

Andriy Gelman Oct. 6, 2019, 5:49 a.m. UTC
From: Andriy Gelman <andriy.gelman@gmail.com>

Silence detection can only be set with the -algorithm 3 option, so
update the documentation.
---
 doc/muxers.texi | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

Comments

Gyan Oct. 6, 2019, 6:58 a.m. UTC | #1
On 06-10-2019 11:19 AM, Andriy Gelman wrote:
> From: Andriy Gelman <andriy.gelman@gmail.com>
>
> Silence detection can only be set with the -algorithm 3 option, so
> update the documentation.
> ---
>   doc/muxers.texi | 10 ++++++----
>   1 file changed, 6 insertions(+), 4 deletions(-)
>
> diff --git a/doc/muxers.texi b/doc/muxers.texi
> index b3da8bf12e..cad376aaeb 100644
> --- a/doc/muxers.texi
> +++ b/doc/muxers.texi
> @@ -105,12 +105,14 @@ It takes a single signed native-endian 16-bit raw audio stream of at most 2 chan
>   
>   @table @option
>   @item silence_threshold
> -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.
> +Threshold for detecting silence, ranges from -1 to 32767, where -1 disables
> +silence detection. Silence detection can only be used with version 3 of the
> +algorithm (i.e. with -algorithm 3 option). Silence detection is required for use
> +with the AcoustID service. Default is -1.
Do you have a cite for the version requirement?

>   @item algorithm
> -Version of algorithm to fingerprint with. Range is 0 to 4. Version 2 requires that silence
> -detection be enabled. Default is 1.
> +Version of algorithm to fingerprint with. Range is 0 to 4. Version 3 (-alogrithm
> +3 option) enables silence detection. Default is 1.
>   
>   @item fp_format
>   Format to output the fingerprint as. Accepts the following options:

Gyan
Andriy Gelman Oct. 6, 2019, 1:13 p.m. UTC | #2
On Sun, 06. Oct 12:28, Gyan wrote:
> 
> 
> On 06-10-2019 11:19 AM, Andriy Gelman wrote:
> > From: Andriy Gelman <andriy.gelman@gmail.com>
> > 
> > Silence detection can only be set with the -algorithm 3 option, so
> > update the documentation.
> > ---
> >   doc/muxers.texi | 10 ++++++----
> >   1 file changed, 6 insertions(+), 4 deletions(-)
> > 
> > diff --git a/doc/muxers.texi b/doc/muxers.texi
> > index b3da8bf12e..cad376aaeb 100644
> > --- a/doc/muxers.texi
> > +++ b/doc/muxers.texi
> > @@ -105,12 +105,14 @@ It takes a single signed native-endian 16-bit raw audio stream of at most 2 chan
> >   @table @option
> >   @item silence_threshold
> > -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.
> > +Threshold for detecting silence, ranges from -1 to 32767, where -1 disables
> > +silence detection. Silence detection can only be used with version 3 of the
> > +algorithm (i.e. with -algorithm 3 option). Silence detection is required for use
> > +with the AcoustID service. Default is -1.

> Do you have a cite for the version requirement?

Yes, https://oxygene.sk/2012/09/chromaprint-0-7-released/ (see the last bullet
point in the release notes):

    "API to configure fingerprint algorithms, currently only 
    used by CHROMAPRINT_ALGORITHM_TEST4."

where
CHROMAPRINT_ALGORITHM_TEST4 is selected without our -algorithm 3 option.

I can add the reference in the next version of the patch or feel free to change
it on your side. 

Thanks,
Gyan Oct. 6, 2019, 2:37 p.m. UTC | #3
On 06-10-2019 06:43 PM, Andriy Gelman wrote:
> On Sun, 06. Oct 12:28, Gyan wrote:
>>
>> On 06-10-2019 11:19 AM, Andriy Gelman wrote:
>>> From: Andriy Gelman <andriy.gelman@gmail.com>
>>>
>>> Silence detection can only be set with the -algorithm 3 option, so
>>> update the documentation.
>>> ---
>>>    doc/muxers.texi | 10 ++++++----
>>>    1 file changed, 6 insertions(+), 4 deletions(-)
>>>
>>> diff --git a/doc/muxers.texi b/doc/muxers.texi
>>> index b3da8bf12e..cad376aaeb 100644
>>> --- a/doc/muxers.texi
>>> +++ b/doc/muxers.texi
>>> @@ -105,12 +105,14 @@ It takes a single signed native-endian 16-bit raw audio stream of at most 2 chan
>>>    @table @option
>>>    @item silence_threshold
>>> -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.
>>> +Threshold for detecting silence, ranges from -1 to 32767, where -1 disables
>>> +silence detection. Silence detection can only be used with version 3 of the
>>> +algorithm (i.e. with -algorithm 3 option). Silence detection is required for use
>>> +with the AcoustID service. Default is -1.
>> Do you have a cite for the version requirement?
> Yes, https://oxygene.sk/2012/09/chromaprint-0-7-released/ (see the last bullet
> point in the release notes):
>
>      "API to configure fingerprint algorithms, currently only
>      used by CHROMAPRINT_ALGORITHM_TEST4."
>
> where
> CHROMAPRINT_ALGORITHM_TEST4 is selected without our -algorithm 3 option.

Ok, patch LGTM; will apply.

Gyan
diff mbox

Patch

diff --git a/doc/muxers.texi b/doc/muxers.texi
index b3da8bf12e..cad376aaeb 100644
--- a/doc/muxers.texi
+++ b/doc/muxers.texi
@@ -105,12 +105,14 @@  It takes a single signed native-endian 16-bit raw audio stream of at most 2 chan
 
 @table @option
 @item silence_threshold
-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.
+Threshold for detecting silence, ranges from -1 to 32767, where -1 disables
+silence detection. Silence detection can only be used with version 3 of the
+algorithm (i.e. with -algorithm 3 option). Silence detection is required for use
+with the AcoustID service. Default is -1.
 
 @item algorithm
-Version of algorithm to fingerprint with. Range is 0 to 4. Version 2 requires that silence
-detection be enabled. Default is 1.
+Version of algorithm to fingerprint with. Range is 0 to 4. Version 3 (-alogrithm
+3 option) enables silence detection. Default is 1.
 
 @item fp_format
 Format to output the fingerprint as. Accepts the following options: