[Scummvm-cvs-logs] CVS: scummvm/doc 07_07.tex,1.1,1.2

Max Horn fingolfin at users.sourceforge.net
Sat Jan 21 05:15:01 CET 2006


Update of /cvsroot/scummvm/scummvm/doc
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv26256

Modified Files:
	07_07.tex 
Log Message:
Sync latex doc section on extraction tools with README/reality

Index: 07_07.tex
===================================================================
RCS file: /cvsroot/scummvm/scummvm/doc/07_07.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- 07_07.tex	20 Jan 2006 00:19:57 -0000	1.1
+++ 07_07.tex	21 Jan 2006 13:14:15 -0000	1.2
@@ -1,8 +1,8 @@
 
-%%% Local Variables: 
+%%% Local Variables:
 %%% mode: latex
 %%% TeX-master: "readme"
-%%% End: 
+%%% End:
 
 \subsection{Using compressed audiofiles (MP3, Ogg Vorbis, Flac)}
 \label{sect-compressing-audiofiles}
@@ -12,7 +12,7 @@
 Use LAME or some other MP3 encoder to rip the CD audio tracks to files. Name
 the files track1.mp3 track2.mp3 etc. ScummVM must be compiled with MAD support
 to use this option. You'll need to rip the file from the CD as a WAV file,
-then encode the MP3 files in constant bit rate. This can be done with the 
+then encode the MP3 files in constant bit rate. This can be done with the
 following LAME command line:
 \begin{verbatim}
   lame -t -q 0 -b 96 track1.wav track1.mp3
@@ -33,25 +33,25 @@
 
 \subsubsection{Using Flac files for CD audio}
 Use flac or some other flac encoder to encode the audio tracks to files.
-Name the files track1.flac track2.flac etc. In your filesystem only allows 
-three letter extensions, name the files track1.fla track2.fla etc. 
-ScummVM must be compiled with flac support to use this option. You'll need to 
-rip the files from the CD as a WAV file, then encode the flac files. This can 
+Name the files track1.flac track2.flac etc. In your filesystem only allows
+three letter extensions, name the files track1.fla track2.fla etc.
+ScummVM must be compiled with flac support to use this option. You'll need to
+rip the files from the CD as a WAV file, then encode the flac files. This can
 be done with the following flac command line:
 \begin{verbatim}
   flac --best track1.wav
 \end{verbatim}
 %
 Remember that the quality is always the same, varying encoder options will only
-affect the encoding time and resulting filesize. 
+affect the encoding time and resulting filesize.
 
 
 \subsubsection{Compressing MONSTER.SOU with MP3}
 
-You need LAME, and our extract util from the scummvm-tools package to perform
-this task, and ScummVM must be compiled with MAD support.
+You need LAME, and our compress\_scumm\_sou util from the scummvm-tools package
+to perform this task, and ScummVM must be compiled with MAD support.
 \begin{verbatim}
-  extract monster.sou
+  compress_scumm_sou monster.sou
 \end{verbatim}
 %
 Eventually you will have a much smaller monster.so3 file, copy this file
@@ -62,7 +62,7 @@
 
 As above, but ScummVM must be compiled with OGG support. Run:
 \begin{verbatim}
-  extract --vorbis monster.sou
+  compress_scumm_sou --vorbis monster.sou
 \end{verbatim}
 %
 This should produce a smaller monster.sog file, which you should copy to your
@@ -74,7 +74,7 @@
 
 As above, but ScummVM must be compiled with Flac support. Run:
 \begin{verbatim}
-  extract --flac --best -b 1152 monster.sou
+  compress_scumm_sou --flac --best -b 1152 monster.sou
 \end{verbatim}
 %
 This should produce a smaller monster.sof file, which you should copy to your
@@ -87,29 +87,29 @@
 
 \subsubsection{Compressing sfx/speech in Simon the Sorcerer 1 and 2}
 
-Use our simon2mp3 util from the scummvm-tools package to perform this task.
+Use our compress\_simon util from the scummvm-tools package to perform this task.
 You can choose between multiple target formats, but note that you can only use
 each if ScummVM was compiled with the respective decoder support enabled.
 
 \begin{tabular}[h]{ll}
-  simon2mp3 effects    &(For Acorn CD version of Simon 1)\\
-  simon2mp3 simon      &(For Acorn CD version of Simon 1)\\
-  simon2mp3 effects.voc&(For DOS CD version of Simon 1)\\
-  simon2mp3 simon.voc  &(For DOS CD version of Simon 1)\\
-  simon2mp3 simon.wav  &(For Windows CD version of Simon 1)\\
-  simon2mp3 simon2.voc &(For DOS CD version of Simon 2)\\
-  simon2mp3 simon2.wav &(For Windows CD version of Simon 2)\\
-  simon2mp3 mac        &(For Macintosh version of Simon 2)\\
+  compress\_simon effects    &(For Acorn CD version of Simon 1)\\
+  compress\_simon simon      &(For Acorn CD version of Simon 1)\\
+  compress\_simon effects.voc&(For DOS CD version of Simon 1)\\
+  compress\_simon simon.voc  &(For DOS CD version of Simon 1)\\
+  compress\_simon simon.wav  &(For Windows CD version of Simon 1)\\
+  compress\_simon simon2.voc &(For DOS CD version of Simon 2)\\
+  compress\_simon simon2.wav &(For Windows CD version of Simon 2)\\
+  compress\_simon mac        &(For Macintosh version of Simon 2)\\
 \end{tabular}
 
 For Ogg Vorbis add --vorbis to the options, i.e.
 \begin{verbatim}
-  simon2mp3 --vorbis
+  compress_simon --vorbis
 \end{verbatim}
 %
 For Flac add --flac and optional parameters, i.e.
 \begin{verbatim}
-  simon2mp3 --flac --best -b 1152 
+  compress_simon --flac --best -b 1152
 \end{verbatim}
 %
 Eventually you will have a much smaller *.mp3, *.ogg or *.fla file, copy this
@@ -117,41 +117,43 @@
 
 \subsubsection{Compressing speech/music in Broken Sword 1}
 
-The sword1mp3 tool from the scummvm-tools package can encode music and speech
-to MP3 as well as Ogg Vorbis.
-Easiest way to encode the files is simply copying the executable into your
+The compress\_sword1 tool from the scummvm-tools package can encode music and
+speech to MP3 as well as Ogg Vorbis.
+The easiest way to encode the files is simply copying the executable into your
 BS1 directory (together with the lame encoder) and run it from there.
 This way, it'll automatically encode everything to MP3.
-Afterwards, you can manually remove the SPEECH?.CLU files and the wave music files.
+Afterwards, you can manually remove the SPEECH?.CLU files and the wave music
+files.
 
-Running 
+Running
 \begin{verbatim}
-  sword1mp3 --vorbis
+  compress_sword1 --vorbis
 \end{verbatim}
 %
 will compress the files using Ogg Vorbis instead of MP3.
 
-Use 
+Use
 \begin{verbatim}
-  sword1mp3 --help
+  compress_sword1 --help
 \end{verbatim}
 %
 to get a full list of the options.
 
 \subsubsection{Compressing speech/music in Broken Sword 2}
 
-Use our sword2mp3 util rom the scummvm-tools package to perform this task.
-You can choose between multiple target formats, but note  that you can only use
-each if ScummVM was compiled with the respective decoder support enabled.
+Use our compress\_sword2 util from the scummvm-tools package to perform this
+task. You can choose between multiple target formats, but note  that you can
+only use each if ScummVM was compiled with the respective decoder support
+enabled.
 
 \begin{verbatim}
-  sword2mp3 speech1.clu
-  sword2mp3 music1.clu
+  compress_sword2 speech1.clu
+  compress_sword2 music1.clu
 \end{verbatim}
 %
 For Ogg Vorbis add --vorbis to the options, i.e.
 \begin{verbatim}
-  sword2mp3 --vorbis
+  compress_sword2 --vorbis
 \end{verbatim}
 %
 Eventually you will have a much smaller *.cl3 or *.clg file, copy this file to
@@ -160,6 +162,6 @@
 It is possible to use Flac compression by adding the --flac option. However,
 the resulting *.clf file will actually be larger than the original.
 
-Please note that sword2mp3 will only work with the four speech/music files in
-Broken Sword 2. It will not work with any of the other *.clu files, nor will it
-work with the speech files from Broken Sword 1.
+Please note that compress\_sword2 will only work with the four speech/music
+files in Broken Sword 2. It will not work with any of the other *.clu files,
+nor will it work with the speech files from Broken Sword 1.





More information about the Scummvm-git-logs mailing list