[MPlayer-DOCS] mencoder.xml issues

Torinthiel torinthiel at megapolis.pl
Thu Nov 30 00:45:32 CET 2006


The time has came for me to read mencoder.xml ;)

Here's what I want to point out:

The tables at the first section (a/v codecs and container formats) use
capital and non-capital letters at beginnings liberally. I'd vote for
starting each entri with non-capital letter, except of course for MPEG,
Xvid etc. See patch #1

Section 13.8. Encoding from multiple input image files (JPEG, PNG, TGA,
SGI): The title of this section is the only place in the whole file
where I (or grep) find SGI. Either add some text/examples or remove it
from the title.

Examples: Almost all of them have overly long lines. Most of them can be
broken (see patch #2), sometimes by reordering the options, hopefully
I've done it right (will double check before commiting). A lot of them
also have missing <replaceable> tags, added as well.

The i_certify_that_my_video_stream_does_not_use_b_frames -lavf option:
At first I thought it was 'insert here all options to certify...', not
a real option name. I even translated it in first try. Only grepping the
sources convinced me otherwise. Maybe it would be worth noting this in
documentation. Good thing at least there's a big fat explanation if you
omit this option.
Torinthiel

-- 
 Waclaw "Torinthiel" Schiller       GG#: 3073512
   torinthiel(at)megapolis(dot)pl
   gpg: 0906A2CE fpr: EE3E DFB4 C4D6 E22E 8999  D714 7CEB CDDC 0906 A2CE
 "No classmates may be used during this examination"
-------------- next part --------------
Index: DOCS/xml/en/mencoder.xml
===================================================================
--- DOCS/xml/en/mencoder.xml	(revision 21394)
+++ DOCS/xml/en/mencoder.xml	(working copy)
@@ -37,11 +37,11 @@
 <tbody>
   <row>
     <entry>mp3lame</entry>
-    <entry>Encode to VBR, ABR or CBR MP3 with LAME</entry>
+    <entry>encode to VBR, ABR or CBR MP3 with LAME</entry>
   </row>
   <row>
     <entry>lavc</entry>
-    <entry>Use one of <link linkend="menc-feat-enc-libavcodec-audio-codecs"><systemitem class="library">libavcodec</systemitem>'s audio codecs</link>
+    <entry>use one of <link linkend="menc-feat-enc-libavcodec-audio-codecs"><systemitem class="library">libavcodec</systemitem>'s audio codecs</link>
     </entry>
   </row>
   <row>
@@ -58,11 +58,11 @@
   </row>
   <row>
     <entry>pcm</entry>
-    <entry>Uncompressed PCM audio</entry>
+    <entry>uncompressed PCM audio</entry>
   </row>
   <row>
     <entry>copy</entry>
-    <entry>Do not reencode, just copy compressed frames</entry>
+    <entry>do not reencode, just copy compressed frames</entry>
   </row>
 </tbody>
 </tgroup>
@@ -79,7 +79,7 @@
 <tbody>
   <row>
     <entry>lavc</entry>
-    <entry>Use one of <link linkend="menc-feat-enc-libavcodec-video-codecs"><systemitem class="library">libavcodec</systemitem>'s video codecs</link>
+    <entry>use one of <link linkend="menc-feat-enc-libavcodec-video-codecs"><systemitem class="library">libavcodec</systemitem>'s video codecs</link>
     </entry>
   </row>
   <row>
@@ -96,15 +96,15 @@
   </row>
   <row>
     <entry>raw</entry>
-    <entry>Uncompressed video frames</entry>
+    <entry>uncompressed video frames</entry>
   </row>
   <row>
     <entry>copy</entry>
-    <entry>Do not reencode, just copy compressed frames</entry>
+    <entry>do not reencode, just copy compressed frames</entry>
   </row>
   <row>
     <entry>frameno</entry>
-    <entry>Used for 3-pass encoding (not recommended)</entry>
+    <entry>used for 3-pass encoding (not recommended)</entry>
   </row>
 </tbody>
 </tgroup>
@@ -129,7 +129,7 @@
 <tbody>
   <row>
     <entry>lavf</entry>
-    <entry>One of the containers supported by
+    <entry>one of the containers supported by
     <systemitem class="library">libavformat</systemitem></entry>
   </row>
   <row>
-------------- next part --------------
Index: DOCS/xml/en/mencoder.xml
===================================================================
--- DOCS/xml/en/mencoder.xml	(revision 21394)
+++ DOCS/xml/en/mencoder.xml	(working copy)
@@ -245,9 +245,9 @@
   Creating a Macromedia Flash video suitable for playback in a web browser
   with the Macromedia Flash plugin:
 <screen>
-mencoder <replaceable>input.avi</replaceable> -o <replaceable>output.flv</replaceable> -of lavf -oac mp3lame -lameopts abr:br=56 -ovc lavc \
--lavcopts vcodec=flv:vbitrate=500:mbd=2:mv0:trell:v4mv:cbp:last_pred=3 \
--srate 22050
+mencoder <replaceable>input.avi</replaceable> -o <replaceable>output.flv</replaceable> -of lavf \
+    -oac mp3lame -lameopts abr:br=56 -srate 22050 -ovc lavc \
+    -lavcopts vcodec=flv:vbitrate=500:mbd=2:mv0:trell:v4mv:cbp:last_pred=3
 </screen>
 </para>
 </informalexample>
@@ -321,7 +321,8 @@
 AVI while copying the audio track.
 <screen>
 mencoder dvd://2 -ovc lavc -lavcopts vcodec=mpeg4:vpass=1 -oac copy -o /dev/null
-mencoder dvd://2 -ovc lavc -lavcopts vcodec=mpeg4:mbd=2:trell:vpass=2 -oac copy -o <replaceable>output.avi</replaceable>
+mencoder dvd://2 -ovc lavc -lavcopts vcodec=mpeg4:mbd=2:trell:vpass=2 \
+    -oac copy -o <replaceable>output.avi</replaceable>
 </screen>
 </para>
 </example>
@@ -334,8 +335,10 @@
 Be careful using this method as it may lead to audio/video desync in
 some cases.
 <screen>
-mencoder dvd://2 -ovc lavc -lavcopts vcodec=mpeg4:vpass=1 -oac mp3lame -lameopts vbr=3 -o /dev/null
-mencoder dvd://2 -ovc lavc -lavcopts vcodec=mpeg4:mbd=2:trell:vpass=2 -oac mp3lame -lameopts vbr=3 -o <replaceable>output.avi</replaceable>
+mencoder dvd://2 -ovc lavc -lavcopts vcodec=mpeg4:vpass=1 \
+    -oac mp3lame -lameopts vbr=3 -o /dev/null
+mencoder dvd://2 -ovc lavc -lavcopts vcodec=mpeg4:mbd=2:trell:vpass=2 \
+    -oac mp3lame -lameopts vbr=3 -o <replaceable>output.avi</replaceable>
 </screen>
 </para>
 </example>
@@ -374,9 +377,10 @@
 <title>encode for PSP</title>
 <para>
 <screen>
-mencoder -oac lavc -ovc lavc -of lavf -lavcopts aglobal=1:vglobal=1:vcodec=mpeg4:acodec=aac \
--af lavcresample=24000 -vf harddup -lavfopts format=psp:i_certify_that_my_video_stream_does_not_use_b_frames \
--ofps 30000/1001 input.video -o output.psp
+mencoder -ofps 30000/1001 -af resample=24000 -vf harddup -of lavf \
+-oac lavc -ovc lavc  -lavcopts aglobal=1:vglobal=1:vcodec=mpeg4:acodec=aac \
+-lavfopts format=psp:i_certify_that_my_video_stream_does_not_use_b_frames \
+<replaceable>input.video</replaceable> -o <replaceable>output.psp</replaceable>
 </screen>
   Note that you can set the title of the video with
   <option>-info name=<replaceable>MovieTitle</replaceable></option>.
@@ -406,19 +410,22 @@
 <para>
 Example:
 <screen>
-mencoder <replaceable>input.avi</replaceable> -of mpeg -ovc lavc -lavcopts vcodec=mpeg1video -oac copy <replaceable>other_options</replaceable> -o <replaceable>output.mpg</replaceable>
+mencoder <replaceable>input.avi</replaceable> -of mpeg -ovc lavc -lavcopts vcodec=mpeg1video \
+    -oac copy <replaceable>other_options</replaceable> -o <replaceable>output.mpg</replaceable>
 </screen>
 Creating an MPEG-1 file suitable to be played on systems with minimal
 multimedia support, such as default Windows installs:
 <screen>
-mencoder <replaceable>input.avi</replaceable> -of mpeg -mpegopts format=mpeg1:tsaf:muxrate=2000 -o <replaceable>output.mpg</replaceable> -oac lavc -ovc lavc \
--lavcopts acodec=mp2:abitrate=224:vcodec=mpeg1video:vbitrate=1152:keyint=15:mbd=2:aspect=4/3
+mencoder <replaceable>input.avi</replaceable> -of mpeg -mpegopts format=mpeg1:tsaf:muxrate=2000 \
+    -o <replaceable>output.mpg</replaceable> -oac lavc -lavcoptc acodec=mp2:abitrate=224 -ovc lavc \
+    -lavcopts vcodec=mpeg1video:vbitrate=1152:keyint=15:mbd=2:aspect=4/3
 </screen>
 Same, but using <systemitem class="library">libavformat</systemitem> MPEG muxer:
 <screen>
-mencoder <replaceable>input.avi</replaceable> -of lavf -lavfopts format=mpg:i_certify_that_my_video_stream_does_not_use_b_frames \
--ovc lavc -lavcopts vcodec=mpeg1video:vrc_buf_size=327:keyint=15:vrc_maxrate=1152:vbitrate=1152:vmax_b_frames=0 \
--o VCD.mpg -ofps 25 -vf scale=352:288,harddup -oac lavc -lavcopts acodec=mp2:abitrate=224
+mencoder <replaceable>input.avi</replaceable> -o VCD.mpg -ofps 25 -vf scale=352:288,harddup -of lavf \
+    -lavfopts format=mpg:i_certify_that_my_video_stream_does_not_use_b_frames \
+    -oac lavc -lavcopts acodec=mp2:abitrate=224 -ovc lavc \
+    -lavcopts vcodec=mpeg1video:vrc_buf_size=327:keyint=15:vrc_maxrate=1152:vbitrate=1152:vmax_b_frames=0 \
 </screen>
 </para>
 </informalexample>
@@ -458,7 +465,8 @@
 <para>
 Usage:
 <screen>
-mencoder <replaceable>input.mpg</replaceable> -ovc lavc -lavcopts vcodec=mpeg4:mbd=2:trell -vf scale=640:480 -o <replaceable>output.avi</replaceable>
+mencoder <replaceable>input.mpg</replaceable> -ovc lavc -lavcopts vcodec=mpeg4:mbd=2:trell \
+    -vf scale=640:480 -o <replaceable>output.avi</replaceable>
 </screen>
 </para>
 </sect1>
@@ -505,7 +513,8 @@
 <para>
 Example:
 <screen>
-mencoder <replaceable>input.nsv</replaceable> -oac copy -fafmttag 0x706D -ovc lavc -lavcopts vcodec=mpeg4:mbd=2:trell -o <replaceable>output.avi</replaceable>
+mencoder <replaceable>input.nsv</replaceable> -oac copy -fafmttag 0x706D \
+    -ovc lavc -lavcopts vcodec=mpeg4:mbd=2:trell -o <replaceable>output.avi</replaceable>
 </screen>
 </para>
 
@@ -543,7 +553,8 @@
 <para>
 Creating an MPEG-4 file from all the JPEG files in the current directory:
 <screen>
-mencoder mf://*.jpg -mf w=800:h=600:fps=25:type=jpg -ovc lavc -lavcopts vcodec=mpeg4:mbd=2:trell -oac copy -o <replaceable>output.avi</replaceable>
+mencoder mf://*.jpg -mf w=800:h=600:fps=25:type=jpg -ovc lavc \
+    -lavcopts vcodec=mpeg4:mbd=2:trell -oac copy -o <replaceable>output.avi</replaceable>
 </screen>
 </para>
 </informalexample>
@@ -552,7 +563,8 @@
 <para>
 Creating an MPEG-4 file from some JPEG files in the current directory:
 <screen>
-mencoder mf://<replaceable>frame001.jpg,frame002.jpg</replaceable> -mf w=800:h=600:fps=25:type=jpg -ovc lavc -lavcopts vcodec=mpeg4:mbd=2:trell -oac copy -o <replaceable>output.avi</replaceable>
+mencoder mf://<replaceable>frame001.jpg,frame002.jpg</replaceable> -mf w=800:h=600:fps=25:type=jpg \
+    -ovc lavc -lavcopts vcodec=mpeg4:mbd=2:trell -oac copy -o <replaceable>output.avi</replaceable>
 </screen>
 </para>
 </informalexample>
@@ -563,7 +575,7 @@
 contains the list of files to use as source, one per line):
 <screen>
 mencoder mf://<replaceable>@list.txt</replaceable> -mf w=800:h=600:fps=25:type=jpg \ 
--ovc lavc -lavcopts vcodec=mpeg4:mbd=2:trell -oac copy -o <replaceable>output.avi</replaceable>
+    -ovc lavc -lavcopts vcodec=mpeg4:mbd=2:trell -oac copy -o <replaceable>output.avi</replaceable>
 </screen>
 </para>
 </informalexample>
@@ -657,17 +669,20 @@
 <example id="copying_two_subtitles_from_a_dvd_while_doing_two_pass_encoding">
 <title>Copying two subtitles from a DVD while doing two pass encoding</title>
 <screen>
-rm subtitles.idx subtitles.sub
-mencoder dvd://1 -oac copy -ovc lavc -lavcopts vcodec=mpeg4:vpass=1 -vobsubout subtitles -vobsuboutindex 0 -sid 2
-mencoder dvd://1 -oac copy -ovc lavc -lavcopts vcodec=mpeg4:mbd=2:trell:vpass=2 -vobsubout subtitles -vobsuboutindex 1 -sid 5<!--
+rm <replaceable>subtitles.idx</replaceable> <replaceable>subtitles.sub</replaceable>
+mencoder dvd://1 -oac copy -ovc lavc -lavcopts vcodec=mpeg4:vpass=1 \
+    -vobsubout <replaceable>subtitles</replaceable> -vobsuboutindex 0 -sid 2
+mencoder dvd://1 -oac copy -ovc lavc -lavcopts vcodec=mpeg4:mbd=2:trell:vpass=2 \
+    -vobsubout <replaceable>subtitles</replaceable> -vobsuboutindex 1 -sid 5<!--
 --></screen>
 </example>
 
 <example id="copying_a_french_subtitle_from_an_mpeg_file">
 <title>Copying a French subtitle from an MPEG file</title>
 <screen>
-rm subtitles.idx subtitles.sub
-mencoder <replaceable>movie.mpg</replaceable> -ifo <replaceable>movie.ifo</replaceable> -vobsubout subtitles -vobsuboutindex 0 -vobsuboutid fr -sid 1 -nosound -ovc copy
+rm <replaceable>subtitles.idx</replaceable> <replaceable>subtitles.sub</replaceable>
+mencoder <replaceable>movie.mpg</replaceable> -ifo <replaceable>movie.ifo</replaceable> -vobsubout <replaceable>subtitles</replaceable> -vobsuboutindex 0 \
+    -vobsuboutid fr -sid 1 -nosound -ovc copy
 </screen>
 </example>
 
@@ -709,7 +724,8 @@
 
 <para>
 Usage
-<screen>mencoder <replaceable>sample-svcd.mpg</replaceable> -ovc lavc -lavcopts vcodec=mpeg4:mbd=2:trell:autoaspect -vf crop=714:548:0:14 -oac copy -o <replaceable>output.avi</replaceable></screen>
+<screen>mencoder <replaceable>sample-svcd.mpg</replaceable> -vf crop=714:548:0:14 -oac copy -ovc lavc \
+    -lavcopts vcodec=mpeg4:mbd=2:trell:autoaspect -o <replaceable>output.avi</replaceable></screen>
 </para>
 </sect1>
 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
URL: <http://lists.mplayerhq.hu/pipermail/mplayer-docs/attachments/20061130/bdaf4b18/attachment.pgp>


More information about the MPlayer-DOCS mailing list