[MPlayer-dev-eng] [PATCH] Documentation of XviD options in man page

[Guillaume POIRIER]

Diego Biurrun wrote:
> Guillaume POIRIER writes:
>> .B interlacing
>>-enable support for interlaced content (default=off)
>>+For interlaced video material, turn this option to on.
>>+NB this option does not deinterlace video, it encodes it field-based
>>+(default: off)
> 
> Hmm, what is NB?
It's latin. This means Nota Bene. Since this abreviation doesn't seem 
cristal-clear, I changed it to juste "note"
> 
> 
>> .B 4mv\ \ \ \ 
>> use 4 motion vectors per macro-block, might give better compression at the
>>-cost of a slower encoding (default=off)
>>+cost of a slower encoding (default: off)
>>+.br
>>+.I
>>+WARNING:
>>+This option isn't compatible with XviD-1.0.x
> How is this option incompatible with 1.0.x?  There is a different set
> of options for XviD 1.0.
Well, it's just that mencoder seems not to know this option when I try a 
compression with XviD 1.0. I don't know why though... maybe just because 
there's no such option in XviD 1.0!
I wrote
.I WARNING:
This option doesn't exist in XviD-1.0.x
instead.
>> .B greyscale
>>-encode in black & white (default=off)
>>+XviD discard chroma planes bitstream so the encoded video is greyscale only.
>>+Note that this does not speed up encoding, that just prevent chroma data
>>+from being written in the last stage of encoding.
>>+This setting enable Chroma color discarding.
>>+(default: off)
> 
> 
> Dunno what happened here, but your grammar suffered a blackout in this
> paragraph.  Also the last sentence seems redundant.  Here is what I
> would suggest (I hope it is still correct):
> 
>   Make XviD discard chroma planes so the encoded video is greyscale only.
>   Note that this does not speed up encoding, it just prevents chroma data
>   from being written in the last stage of encoding.
I do prefer the way you write it, as for the next re-write that you 
suggested. Changed

>> .B keyframe_boost=<0\-1000>
>>-(default=0, 2pass mode only)
>>+This setting tells how many additional amount of bits, Intra Frames are
>>+supposed to be given (this "boosting" amount of bits is compensated by
>>+subtracting the same amount of bits from other frame types pool)
> 
> 
> If it's countable you say many, otherwise you say much.  I would
> suggest the following, hopefully clearer and still correct version:
> 
>   Shift some bits from the pool for other frame types to intra frames.
Ok, I changed that too, to have a simpler and clearer sentence.

>> .B kfthreshold=<value>
>> .B kfreduction=<0\-100>
I re-wrote the doc of those two settings, as their desciption was too 
confusing
I hope it would clarify a bit

> Please send in an updated version, I'll apply it.
> Thanks
Here it is!

Greetings,
Guillaume
-------------- next part --------------
A non-text attachment was scrubbed...
Name: mplayer1.0-cvs-man_xvid_options.patch
Type: text/x-patch
Size: 9847 bytes
Desc: not available
URL: <http://lists.mplayerhq.hu/pipermail/mplayer-dev-eng/attachments/20040809/dd4c0927/attachment.bin>