[Scummvm-cvs-logs] CVS: docs/docbook manual.html,1.5,1.6 manual.pdf,1.5,1.6 manual.txt,1.4,1.5 manual.xml,1.6,1.7
Max Horn
fingolfin at users.sourceforge.net
Sat Dec 4 18:32:00 CET 2004
- Previous message: [Scummvm-cvs-logs] CVS: tools extract.c,1.41,1.42 simon2mp3.c,1.34,1.35 sword2mp3.c,1.2,1.3
- Next message: [Scummvm-cvs-logs] CVS: scummvm/sword1 credits.cpp,NONE,1.1 credits.h,NONE,1.1 animation.cpp,1.27,1.28 animation.h,1.13,1.14 logic.cpp,1.43,1.44 sword1.cpp,1.67,1.68 sword1.h,1.20,1.21
- Messages sorted by:
[ date ]
[ thread ]
[ subject ]
[ author ]
Update of /cvsroot/scummvm/docs/docbook
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv17054
Modified Files:
manual.html manual.pdf manual.txt manual.xml
Log Message:
Adding some material to Appendix B (Tools) -- this needs to be cleaned up, though
Index: manual.html
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.html,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- manual.html 5 Dec 2004 01:37:22 -0000 1.5
+++ manual.html 5 Dec 2004 02:31:06 -0000 1.6
@@ -84,12 +84,14 @@
<dd>
<dl>
<dt>B.1. <a href="#AEN355">compress_san</a></dt>
-<dt>B.2. <a href="#AEN358">extract</a></dt>
-<dt>B.3. <a href="#AEN361">simon2mp3</a></dt>
-<dt>B.4. <a href="#AEN364">sword2mp3</a></dt></dl></dd>
-<dt>C. <a href="#AEN367">Credits</a></dt>
-<dt><a href="#AEN538">Glossary</a></dt>
-<dt><a href="#AEN561">Index</a></dt></dl></div>
+<dt>B.2. <a href="#AEN371">extract</a></dt>
+<dt>B.3. <a href="#AEN376">queenrebuild</a></dt>
+<dt>B.4. <a href="#AEN381">simon2mp3</a></dt>
+<dt>B.5. <a href="#AEN386">sword1mp3</a></dt>
+<dt>B.6. <a href="#AEN391">sword2mp3</a></dt></dl></dd>
+<dt>C. <a href="#AEN397">Credits</a></dt>
+<dt><a href="#AEN568">Glossary</a></dt>
+<dt><a href="#AEN591">Index</a></dt></dl></div>
<div class="LOT">
<dl class="LOT">
<dt><b>List of Examples</b></dt>
@@ -100,7 +102,8 @@
<dt>3-3. <a href="#AEN299">Running Monkey Island, fullscreen, from
a hard disk (Unix)</a></dt>
<dt>3-4. <a href="#AEN302">Running Full Throttle from CD,
-fullscreen and with subtitles enabled (Unix)</a></dt></dl></div>
+fullscreen and with subtitles enabled (Unix)</a></dt>
+<dt>B-1. <a href="#AEN367">Using compress_san</a></dt></dl></div>
<div class="chapter">
<hr>
<h1><a name="AEN7"></a>Chapter 1. Introduction</h1>
@@ -512,23 +515,201 @@
<div class="section">
<hr>
<h2 class="section"><a name="AEN355">B.1. compress_san</a></h2>
-<p>TODO</p></div>
+<p>TODO</p>
+<p><b class="command">compress_san</b> <tt class=
+"replaceable"><i>inputfile</i></tt> <tt class=
+"replaceable"><i>inputdir</i></tt> <tt class=
+"replaceable"><i>outputdir</i></tt></p>
+<p>
Compresses '.san' smush animation files. It uses lossless
+zlib for compressing FOBJ gfx chunks inside a san file. It also can
+create ogg separate file with smush audio track (only COMI
+currently supported).</p>
+<div class="example"><a name="AEN367"></a>
+<p><b>Example B-1. Using compress_san</b></p>
+<pre class="screen">
+compress_san opening.san uncomp comp
+</pre>
+</div>
+<p>
In order to use such compressed files, your ScummVM binary
+must have been built with zlib support enabled (you can find out
+whether that's the case by looking at the About dialog). For the
+Ogg compression feature, your ScummVM binary naturally must have
+been built with Ogg support enabled.</p></div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN358">B.2. extract</a></h2>
-<p>TODO</p></div>
+<h2 class="section"><a name="AEN371">B.2. extract</a></h2>
+<p>TODO</p>
+<p>Used to compress .sou files to .so3 (MP3), .sog (Vorbis), or
+.sof (FLAC).</p>
+<pre class="screen">
+
Usage: ./extract [params] monster.sou
+
+Params:
+ --mp3 encode to MP3 format (default)
+ --vorbis encode to Vorbis format
+ --flac encode to Flac format
+(If one of these is specified, it must be the first parameter.)
+
+MP3 mode params:
+ -b RATE RATE is the target bitrate(ABR)/minimal bitrate(VBR) (default:24)
+ -B RATE RATE is the maximum VBR/ABR bitrate (default:64)
+ --vbr LAME uses the VBR mode (default)
+ --abr LAME uses the ABR mode
+ -V VALUE specifies the value (0 - 9) of VBR quality (0=best) (default:4)
+ -q VALUE specifies the MPEG algorithm quality (0-9; 0=best) (default:2)
+ --silent the output of LAME is hidden (default:disabled)
+
+Vorbis mode params:
+ -b RATE RATE is the nominal bitrate (default:unset)
+ -m RATE RATE is the minimum bitrate (default:unset)
+ -M RATE RATE is the maximum bitrate (default:unset)
+ -q VALUE specifies the value (0 - 10) of VBR quality (10=best) (default:3)
+ --silent the output of oggenc is hidden (default:disabled)
+
+Flac mode params:
+ [params] optional arguments passed directly to the encoder
+ recommended is: --best -b 1152
+
+ --help this help message
+
+
+If a parameter is not given the default value is used
+If using VBR mode for MP3 -b and -B must be multiples of 8; the maximum is 160!
+</pre>
+</div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN361">B.3. simon2mp3</a></h2>
-<p>TODO</p></div>
+<h2 class="section"><a name="AEN376">B.3. queenrebuild</a></h2>
+<p>TODO</p>
+<p>Used to rebuild the datafile of Flight of the Amazon Queen, to
+allow optional MP3/Ogg/FLAC compression.</p>
+<pre class="screen">
+
Usage: ./queenrebuild [--mp3/--ogg/--flac [args]] queen.1
+
+Params:
+ --mp3 [args] encode to MP3 format
+ --ogg [args] encode to Ogg Vorbis Format
+ --flac [args] encode to Flac Format
+ (Optional: [args] are passed on to the encoder)
+
+Example: ./queenrebuild --mp3 -q 5 queen.1
+</pre>
+</div>
<div class="section">
<hr>
-<h2 class="section"><a name="AEN364">B.4. sword2mp3</a></h2>
-<p>TODO</p></div></div>
+<h2 class="section"><a name="AEN381">B.4. simon2mp3</a></h2>
+<p>TODO</p>
+<p>Compresses Simon voc/wav files to MP3/Ogg/FLAC.</p>
+<pre class="screen">
+
Usage: ./simon2mp3 [params] [file | mac]
+
+Params:
+ --mp3 encode to MP3 format (default)
+ --vorbis encode to Vorbis format
+ --flac encode to Flac format
+(If one of these is specified, it must be the first parameter.)
+
+MP3 mode params:
+ -b RATE RATE is the target bitrate(ABR)/minimal bitrate(VBR) (default:24)
+ -B RATE RATE is the maximum VBR/ABR bitrate (default:64)
+ --vbr LAME uses the VBR mode (default)
+ --abr LAME uses the ABR mode
+ -V VALUE specifies the value (0 - 9) of VBR quality (0=best) (default:4)
+ -q VALUE specifies the MPEG algorithm quality (0-9; 0=best) (default:2)
+ --silent the output of LAME is hidden (default:disabled)
+
+Vorbis mode params:
+ -b RATE RATE is the nominal bitrate (default:unset)
+ -m RATE RATE is the minimum bitrate (default:unset)
+ -M RATE RATE is the maximum bitrate (default:unset)
+ -q VALUE specifies the value (0 - 10) of VBR quality (10=best) (default:3)
+ --silent the output of oggenc is hidden (default:disabled)
+
+Flac mode params:
+ [params] optional arguments passed directly to the encoder
+ recommended is: --best -b 1152
+
+ --help this help message
+
+
+If a parameter is not given the default value is used
+If using VBR mode for MP3 -b and -B must be multiples of 8; the maximum is 160!
+Use the `mac' option instead of a filename if converting simon2mac sounds
+</pre>
+</div>
+<div class="section">
+<hr>
+<h2 class="section"><a name="AEN386">B.5. sword1mp3</a></h2>
+<p>TODO</p>
+<p>Used to compress Broken Sword 1's music and speech files using
+mp3 or vorbis.</p>
+<pre class="screen">
+
Unable to find speech files.
+Please copy the SPEECH.CLU files from Broken Sword CD1 and CD2
+into the "SPEECH" subdirectory and rename them to
+SPEECH1.CLU and SPEECH2.CLU
+
+If your OS is case-sensitive, make sure the filenames
+and directorynames are all upper-case.
+
+Unable to find music files.
+Please copy the music files from Broken Sword CD1 and CD2
+into the "MUSIC" subdirectory.
+If your OS is case-sensitive, make sure the filenames
+and directorynames are all upper-case.
+
+Use --help for more information
+</pre>
+</div>
+<div class="section">
+<hr>
+<h2 class="section"><a name="AEN391">B.6. sword2mp3</a></h2>
+<p>TODO</p>
+<p>Used to compress Broken Sword 2's music and speech .clu files to
+.cl3 (MP3), .clg (Vorbis) or .clf (FLAC).</p>
+<p>
Please note that FLAC-compression will produce a larger
+file than the original! This is because the original files already
+use lossy compression.</p>
+<pre class="screen">
+
Usage: ./sword2mp3 [params] file.clu
+
+Params:
+ --mp3 encode to MP3 format (default)
+ --vorbis encode to Vorbis format
+ --flac encode to Flac format
+(If one of these is specified, it must be the first parameter.)
+
+MP3 mode params:
+ -b RATE RATE is the target bitrate(ABR)/minimal bitrate(VBR) (default:24)
+ -B RATE RATE is the maximum VBR/ABR bitrate (default:64)
+ --vbr LAME uses the VBR mode (default)
+ --abr LAME uses the ABR mode
+ -V VALUE specifies the value (0 - 9) of VBR quality (0=best) (default:4)
+ -q VALUE specifies the MPEG algorithm quality (0-9; 0=best) (default:2)
+ --silent the output of LAME is hidden (default:disabled)
+
+Vorbis mode params:
+ -b RATE RATE is the nominal bitrate (default:unset)
+ -m RATE RATE is the minimum bitrate (default:unset)
+ -M RATE RATE is the maximum bitrate (default:unset)
+ -q VALUE specifies the value (0 - 10) of VBR quality (10=best) (default:3)
+ --silent the output of oggenc is hidden (default:disabled)
+
+Flac mode params:
+ [params] optional arguments passed directly to the encoder
+ recommended is: --best -b 1152
+
+ --help this help message
+
+
+If a parameter is not given the default value is used
+If using VBR mode for MP3 -b and -B must be multiples of 8; the maximum is 160!
+</pre>
+</div></div>
<div class="appendix">
<hr>
-<h1><a name="AEN367"></a>Appendix C. Credits</h1>
-<div class="informaltable"><a name="AEN369"></a>
+<h1><a name="AEN397"></a>Appendix C. Credits</h1>
+<div class="informaltable"><a name="AEN399"></a>
<table border="0" frame="void" rules="none" class="CALSTABLE">
<col width="19" title="start">
<col width="151" title="name">
@@ -757,7 +938,7 @@
reimplement that it is today. Feel free to drop us a line and tell
us what you think, guys!</p></div>
<div class="GLOSSARY">
-<h1><a name="AEN538"></a>Glossary</h1>
+<h1><a name="AEN568"></a>Glossary</h1>
<p>TODO: (explaining abbreviations etc.). Like SCUMM, FOTAQ, COMI,
FOA, ITE, ...</p>
<dl>
@@ -780,7 +961,7 @@
<p>TODO</p></dd></dl></div>
<div class="index">
<hr>
-<h1><a name="AEN561"></a>Index</h1>
+<h1><a name="AEN591"></a>Index</h1>
<p>TODO: Note that docbook can be used to automate the generation
of an index!</p></div></div>
</body>
Index: manual.pdf
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.pdf,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- manual.pdf 5 Dec 2004 01:37:22 -0000 1.5
+++ manual.pdf 5 Dec 2004 02:31:06 -0000 1.6
@@ -279,96 +279,108 @@
<< /S /GoTo /D (9.27.1) >>
endobj
188 0 obj
-(B.3. simon2mp3)
+(B.3. queenrebuild)
endobj
189 0 obj
<< /S /GoTo /D (9.28.1) >>
endobj
192 0 obj
-(B.4. sword2mp3)
[...5452 lines suppressed...]
+0000146143 00000 n
+0000146237 00000 n
+0000151631 00000 n
+0000157547 00000 n
+0000157586 00000 n
+0000157624 00000 n
+0000157851 00000 n
trailer
<<
-/Size 746
-/Root 744 0 R
-/Info 745 0 R
+/Size 804
+/Root 802 0 R
+/Info 803 0 R
>>
startxref
-144216
+158006
%%EOF
Index: manual.txt
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.txt,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- manual.txt 5 Dec 2004 01:37:24 -0000 1.4
+++ manual.txt 5 Dec 2004 02:31:07 -0000 1.5
@@ -92,9 +92,13 @@
B.2. extract
- B.3. simon2mp3
+ B.3. queenrebuild
- B.4. sword2mp3
+ B.4. simon2mp3
+
+ B.5. sword1mp3
+
+ B.6. sword2mp3
C. Credits
@@ -114,6 +118,8 @@
3-4. Running Full Throttle from CD, fullscreen and with subtitles enabled
(Unix)
+ B-1. Using compress_san
+
----------------------------------------------------------------------
Chapter 1. Introduction
@@ -581,24 +587,198 @@
TODO
+ compress_san inputfile inputdir outputdir
+
+
Compresses '.san' smush animation files. It uses lossless zlib for
+ compressing FOBJ gfx chunks inside a san file. It also can create ogg
+ separate file with smush audio track (only COMI currently supported).
+
+ Example B-1. Using compress_san
+
+ compress_san opening.san uncomp comp
+
+
In order to use such compressed files, your ScummVM binary must have
+ been built with zlib support enabled (you can find out whether that's the
+ case by looking at the About dialog). For the Ogg compression feature,
+ your ScummVM binary naturally must have been built with Ogg support
+ enabled.
+
----------------------------------------------------------------------
B.2. extract
TODO
+ Used to compress .sou files to .so3 (MP3), .sog (Vorbis), or .sof (FLAC).
+
+
Usage: ./extract [params] monster.sou
+
+ Params:
+ --mp3 encode to MP3 format (default)
+ --vorbis encode to Vorbis format
+ --flac encode to Flac format
+ (If one of these is specified, it must be the first parameter.)
+
+ MP3 mode params:
+ -b RATE RATE is the target bitrate(ABR)/minimal bitrate(VBR) (default:24)
+ -B RATE RATE is the maximum VBR/ABR bitrate (default:64)
+ --vbr LAME uses the VBR mode (default)
+ --abr LAME uses the ABR mode
+ -V VALUE specifies the value (0 - 9) of VBR quality (0=best) (default:4)
+ -q VALUE specifies the MPEG algorithm quality (0-9; 0=best) (default:2)
+ --silent the output of LAME is hidden (default:disabled)
+
+ Vorbis mode params:
+ -b RATE RATE is the nominal bitrate (default:unset)
+ -m RATE RATE is the minimum bitrate (default:unset)
+ -M RATE RATE is the maximum bitrate (default:unset)
+ -q VALUE specifies the value (0 - 10) of VBR quality (10=best) (default:3)
+ --silent the output of oggenc is hidden (default:disabled)
+
+ Flac mode params:
+ [params] optional arguments passed directly to the encoder
+ recommended is: --best -b 1152
+
+ --help this help message
+
+
+ If a parameter is not given the default value is used
+ If using VBR mode for MP3 -b and -B must be multiples of 8; the maximum is 160!
+
----------------------------------------------------------------------
-B.3. simon2mp3
+B.3. queenrebuild
TODO
+ Used to rebuild the datafile of Flight of the Amazon Queen, to allow
+ optional MP3/Ogg/FLAC compression.
+
+
Usage: ./queenrebuild [--mp3/--ogg/--flac [args]] queen.1
+
+ Params:
+ --mp3 [args] encode to MP3 format
+ --ogg [args] encode to Ogg Vorbis Format
+ --flac [args] encode to Flac Format
+ (Optional: [args] are passed on to the encoder)
+
+ Example: ./queenrebuild --mp3 -q 5 queen.1
+
----------------------------------------------------------------------
-B.4. sword2mp3
+B.4. simon2mp3
+
+ TODO
+
+ Compresses Simon voc/wav files to MP3/Ogg/FLAC.
+
+
Usage: ./simon2mp3 [params] [file | mac]
+
+ Params:
+ --mp3 encode to MP3 format (default)
+ --vorbis encode to Vorbis format
+ --flac encode to Flac format
+ (If one of these is specified, it must be the first parameter.)
+
+ MP3 mode params:
+ -b RATE RATE is the target bitrate(ABR)/minimal bitrate(VBR) (default:24)
+ -B RATE RATE is the maximum VBR/ABR bitrate (default:64)
+ --vbr LAME uses the VBR mode (default)
+ --abr LAME uses the ABR mode
+ -V VALUE specifies the value (0 - 9) of VBR quality (0=best) (default:4)
+ -q VALUE specifies the MPEG algorithm quality (0-9; 0=best) (default:2)
+ --silent the output of LAME is hidden (default:disabled)
+
+ Vorbis mode params:
+ -b RATE RATE is the nominal bitrate (default:unset)
+ -m RATE RATE is the minimum bitrate (default:unset)
+ -M RATE RATE is the maximum bitrate (default:unset)
+ -q VALUE specifies the value (0 - 10) of VBR quality (10=best) (default:3)
+ --silent the output of oggenc is hidden (default:disabled)
+
+ Flac mode params:
+ [params] optional arguments passed directly to the encoder
+ recommended is: --best -b 1152
+
+ --help this help message
+
+
+ If a parameter is not given the default value is used
+ If using VBR mode for MP3 -b and -B must be multiples of 8; the maximum is 160!
+ Use the `mac' option instead of a filename if converting simon2mac sounds
+
+ ----------------------------------------------------------------------
+
+B.5. sword1mp3
+
+ TODO
+
+ Used to compress Broken Sword 1's music and speech files using mp3 or
+ vorbis.
+
+
Unable to find speech files.
+ Please copy the SPEECH.CLU files from Broken Sword CD1 and CD2
+ into the "SPEECH" subdirectory and rename them to
+ SPEECH1.CLU and SPEECH2.CLU
+
+ If your OS is case-sensitive, make sure the filenames
+ and directorynames are all upper-case.
+
+ Unable to find music files.
+ Please copy the music files from Broken Sword CD1 and CD2
+ into the "MUSIC" subdirectory.
+ If your OS is case-sensitive, make sure the filenames
+ and directorynames are all upper-case.
+
+ Use --help for more information
+
+ ----------------------------------------------------------------------
+
+B.6. sword2mp3
TODO
+ Used to compress Broken Sword 2's music and speech .clu files to .cl3
+ (MP3), .clg (Vorbis) or .clf (FLAC).
+
+
Please note that FLAC-compression will produce a larger file than the
+ original! This is because the original files already use lossy
+ compression.
+
+
Usage: ./sword2mp3 [params] file.clu
+
+ Params:
+ --mp3 encode to MP3 format (default)
+ --vorbis encode to Vorbis format
+ --flac encode to Flac format
+ (If one of these is specified, it must be the first parameter.)
+
+ MP3 mode params:
+ -b RATE RATE is the target bitrate(ABR)/minimal bitrate(VBR) (default:24)
+ -B RATE RATE is the maximum VBR/ABR bitrate (default:64)
+ --vbr LAME uses the VBR mode (default)
+ --abr LAME uses the ABR mode
+ -V VALUE specifies the value (0 - 9) of VBR quality (0=best) (default:4)
+ -q VALUE specifies the MPEG algorithm quality (0-9; 0=best) (default:2)
+ --silent the output of LAME is hidden (default:disabled)
+
+ Vorbis mode params:
+ -b RATE RATE is the nominal bitrate (default:unset)
+ -m RATE RATE is the minimum bitrate (default:unset)
+ -M RATE RATE is the maximum bitrate (default:unset)
+ -q VALUE specifies the value (0 - 10) of VBR quality (10=best) (default:3)
+ --silent the output of oggenc is hidden (default:disabled)
+
+ Flac mode params:
+ [params] optional arguments passed directly to the encoder
+ recommended is: --best -b 1152
+
+ --help this help message
+
+
+ If a parameter is not given the default value is used
+ If using VBR mode for MP3 -b and -B must be multiples of 8; the maximum is 160!
+
----------------------------------------------------------------------
Appendix C. Credits
Index: manual.xml
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- manual.xml 5 Dec 2004 01:37:24 -0000 1.6
+++ manual.xml 5 Dec 2004 02:31:07 -0000 1.7
@@ -627,21 +627,206 @@
<section>
<title>compress_san</title>
<para>TODO</para>
+
+ <cmdsynopsis>
+ <command>compress_san</command>
+ <arg choice='plain'><replaceable>inputfile</replaceable></arg>
+ <arg choice='plain'><replaceable>inputdir</replaceable></arg>
+ <arg choice='plain'><replaceable>outputdir</replaceable></arg>
+ </cmdsynopsis>
+
+ <para>
+ Compresses '.san' smush animation files. It uses lossless zlib
+ for compressing FOBJ gfx chunks inside a san file.
+ It also can create ogg separate file with smush audio track
+ (only COMI currently supported).
+ </para>
+ <example><title>Using compress_san</title>
+ <screen>compress_san opening.san uncomp comp</screen>
+ </example>
+ <para>
+ In order to use such compressed files, your ScummVM binary
+ must have been built with zlib support enabled (you can find
+ out whether that's the case by looking at the About dialog).
+ For the Ogg compression feature, your ScummVM binary naturally
+ must have been built with Ogg support enabled.
+ </para>
</section>
<section>
<title>extract</title>
<para>TODO</para>
+ <para>Used to compress .sou files to .so3 (MP3), .sog (Vorbis),
+ or .sof (FLAC).</para>
+<screen>
+Usage: ./extract [params] monster.sou
+
+Params:
+ --mp3 encode to MP3 format (default)
+ --vorbis encode to Vorbis format
+ --flac encode to Flac format
+(If one of these is specified, it must be the first parameter.)
+
+MP3 mode params:
+ -b RATE RATE is the target bitrate(ABR)/minimal bitrate(VBR) (default:24)
+ -B RATE RATE is the maximum VBR/ABR bitrate (default:64)
+ --vbr LAME uses the VBR mode (default)
+ --abr LAME uses the ABR mode
+ -V VALUE specifies the value (0 - 9) of VBR quality (0=best) (default:4)
+ -q VALUE specifies the MPEG algorithm quality (0-9; 0=best) (default:2)
+ --silent the output of LAME is hidden (default:disabled)
+
+Vorbis mode params:
+ -b RATE RATE is the nominal bitrate (default:unset)
+ -m RATE RATE is the minimum bitrate (default:unset)
+ -M RATE RATE is the maximum bitrate (default:unset)
+ -q VALUE specifies the value (0 - 10) of VBR quality (10=best) (default:3)
+ --silent the output of oggenc is hidden (default:disabled)
+
+Flac mode params:
+ [params] optional arguments passed directly to the encoder
+ recommended is: --best -b 1152
+
+ --help this help message
+
+
+If a parameter is not given the default value is used
+If using VBR mode for MP3 -b and -B must be multiples of 8; the maximum is 160!
+</screen>
+
+ </section>
+
+ <section>
+ <title>queenrebuild</title>
+ <para>TODO</para>
+ <para>Used to rebuild the datafile of Flight of the Amazon Queen,
+ to allow optional MP3/Ogg/FLAC compression.</para>
+<screen>
+Usage: ./queenrebuild [--mp3/--ogg/--flac [args]] queen.1
+
+Params:
+ --mp3 [args] encode to MP3 format
+ --ogg [args] encode to Ogg Vorbis Format
+ --flac [args] encode to Flac Format
+ (Optional: [args] are passed on to the encoder)
+
+Example: ./queenrebuild --mp3 -q 5 queen.1
+</screen>
</section>
<section>
<title>simon2mp3</title>
<para>TODO</para>
+ <para>Compresses Simon voc/wav files to MP3/Ogg/FLAC.</para>
+<screen>
+Usage: ./simon2mp3 [params] [file | mac]
+
+Params:
+ --mp3 encode to MP3 format (default)
+ --vorbis encode to Vorbis format
+ --flac encode to Flac format
+(If one of these is specified, it must be the first parameter.)
+
+MP3 mode params:
+ -b RATE RATE is the target bitrate(ABR)/minimal bitrate(VBR) (default:24)
+ -B RATE RATE is the maximum VBR/ABR bitrate (default:64)
+ --vbr LAME uses the VBR mode (default)
+ --abr LAME uses the ABR mode
+ -V VALUE specifies the value (0 - 9) of VBR quality (0=best) (default:4)
+ -q VALUE specifies the MPEG algorithm quality (0-9; 0=best) (default:2)
+ --silent the output of LAME is hidden (default:disabled)
+
+Vorbis mode params:
+ -b RATE RATE is the nominal bitrate (default:unset)
+ -m RATE RATE is the minimum bitrate (default:unset)
+ -M RATE RATE is the maximum bitrate (default:unset)
+ -q VALUE specifies the value (0 - 10) of VBR quality (10=best) (default:3)
+ --silent the output of oggenc is hidden (default:disabled)
+
+Flac mode params:
+ [params] optional arguments passed directly to the encoder
+ recommended is: --best -b 1152
+
+ --help this help message
+
+
+If a parameter is not given the default value is used
+If using VBR mode for MP3 -b and -B must be multiples of 8; the maximum is 160!
+Use the `mac' option instead of a filename if converting simon2mac sounds
+</screen>
+ </section>
+
+ <section>
+ <title>sword1mp3</title>
+ <para>TODO</para>
+ <para>Used to compress Broken Sword 1's music and speech files
+ using mp3 or vorbis.</para>
+<screen>
+Unable to find speech files.
+Please copy the SPEECH.CLU files from Broken Sword CD1 and CD2
+into the "SPEECH" subdirectory and rename them to
+SPEECH1.CLU and SPEECH2.CLU
+
+If your OS is case-sensitive, make sure the filenames
+and directorynames are all upper-case.
+
+Unable to find music files.
+Please copy the music files from Broken Sword CD1 and CD2
+into the "MUSIC" subdirectory.
+If your OS is case-sensitive, make sure the filenames
+and directorynames are all upper-case.
+
+Use --help for more information
+</screen>
+
</section>
<section>
<title>sword2mp3</title>
<para>TODO</para>
+ <para>Used to compress Broken Sword 2's music and speech .clu
+ files to .cl3 (MP3), .clg (Vorbis) or .clf (FLAC).
+ </para>
+ <para>
+ Please note that FLAC-compression will produce a larger file
+ than the original! This is because the original files already
+ use lossy compression.
+ </para>
+<screen>
+Usage: ./sword2mp3 [params] file.clu
+
+Params:
+ --mp3 encode to MP3 format (default)
+ --vorbis encode to Vorbis format
+ --flac encode to Flac format
+(If one of these is specified, it must be the first parameter.)
+
+MP3 mode params:
+ -b RATE RATE is the target bitrate(ABR)/minimal bitrate(VBR) (default:24)
+ -B RATE RATE is the maximum VBR/ABR bitrate (default:64)
+ --vbr LAME uses the VBR mode (default)
+ --abr LAME uses the ABR mode
+ -V VALUE specifies the value (0 - 9) of VBR quality (0=best) (default:4)
+ -q VALUE specifies the MPEG algorithm quality (0-9; 0=best) (default:2)
+ --silent the output of LAME is hidden (default:disabled)
+
+Vorbis mode params:
+ -b RATE RATE is the nominal bitrate (default:unset)
+ -m RATE RATE is the minimum bitrate (default:unset)
+ -M RATE RATE is the maximum bitrate (default:unset)
+ -q VALUE specifies the value (0 - 10) of VBR quality (10=best) (default:3)
+ --silent the output of oggenc is hidden (default:disabled)
+
+Flac mode params:
+ [params] optional arguments passed directly to the encoder
+ recommended is: --best -b 1152
+
+ --help this help message
+
+
+If a parameter is not given the default value is used
+If using VBR mode for MP3 -b and -B must be multiples of 8; the maximum is 160!
+</screen>
</section>
</appendix>
- Previous message: [Scummvm-cvs-logs] CVS: tools extract.c,1.41,1.42 simon2mp3.c,1.34,1.35 sword2mp3.c,1.2,1.3
- Next message: [Scummvm-cvs-logs] CVS: scummvm/sword1 credits.cpp,NONE,1.1 credits.h,NONE,1.1 animation.cpp,1.27,1.28 animation.h,1.13,1.14 logic.cpp,1.43,1.44 sword1.cpp,1.67,1.68 sword1.h,1.20,1.21
- Messages sorted by:
[ date ]
[ thread ]
[ subject ]
[ author ]
More information about the Scummvm-git-logs
mailing list