[FFmpeg-devel] [PATCH] Document the preset files system

The Wanderer inverseparadox
Sat Oct 4 15:09:40 CEST 2008

Stefano Sabatini wrote:

> On date Friday 2008-10-03 07:15:53 -0400, The Wanderer encoded:
>> Stefano Sabatini wrote:
>>> On date Wednesday 2008-10-01 19:20:28 -0400, The Wanderer
>>> encoded:
>>>> Stefano Sabatini wrote:

>>> +search for a file named @var{codec_name}- at var{arg}.ffpreset in the
>>> +above-mentioned directories, where @var{codec_name} is the name of the
>>> +currently selected codec with the codec type specified by the preset
>>> +option. For example, if you selected the video codec with
>>> + at code{-vcodec libx264} and @code{-vpre max} is used, then it will
>>> +search for the file @file{libx264-max.ffpreset}.
>> How does the preset option specify the codec type? I don't think it
>>  does, and this seems confusing to me.
> The codec type of the preset is detected by the first character of
> the preset option (a/v/s). I'm mentioning this in the documentation
> now.

Ah, I see now. I think we can improve it further; see below.

>> There's something awkward about the "is used", but nothing I'm
>> coming up with in short order is being significantly better, and
>> it's not worth holding up the patch over IMO.
> I changed the verbs forms from "selected ... is used" to "select ...
> use", now it sounds slightly better to my non-native English ears.

Much better, yes.

> +Preset files are specified with the @code{vpre}, @code{apre} and
> + at code{spre} options. The options specified in a preset file are
> +applied to the currently selected codec with the same type
> +specified by the preset option.

While I now know what is meant, even now that you've explained it I have
to think for a moment to get the correct meaning from "with the same
type specified by". I think "of the same type as" would work better as
far as conveying the meaning to someone who has not had the explanation.

With that change, I'd say apply.

       The Wanderer

Warning: Simply because I argue an issue does not mean I agree with any
side of it.

Secrecy is the beginning of tyranny.

More information about the ffmpeg-devel mailing list