README for XingMP3 Encoder v1.5 for Linux
12 May 1999
------------------------------------------------------------------
(c) Copyright Xing Technology Corporation, 1995-1999

* MPEG Layer-3 audio compression technology licensed by Fraunhofer IIS 
  and THOMSON multimedia

--------
CONTENTS
--------
Usage
Known Issues
Valid Source File Types
Producing Quality MPEG Files
Technical Support
Submitting a Problem Report
MP3 Users List

-----
Usage
-----
Usage: xingmp3enc [-B bitrate] [-V vbr_scale] [-M mode] [-A algorithm] 
       [-Q] [-N] [-R] [-S] [-H] [-C copyright_bit] [-O original_bit] 
       [--] <input filename> [output filename]

Option switches may be specified in either upper or lower case, and
either with or without a space separating the option switch and the 
value (if any) for that switch.  For example, the following two 
commands are equivalent:

  xingmp3enc -B128 -M2 -Q input.wav output.mp3
  xingmp3enc -b 128 -M 2 -q input.wav output.mp3


Options:
-H(elp)         Print the help screen

-B <bitrate>    Constant Bit Rate (CBR) to encode with;
                Incompatible with -V option.  You cannot use both
                -B and -V modes at the same time.

                Constant Bit Rate encoding is the default standard 
                for MP3 encoding and produces MP3 files using a 
                constant amount of data per second.  This varies from
                16kbps to 320kbps. The bitrate option is specified in 
                number of kbps.

                Typical valid bitrates for single-channel (mono) encoding
                are:
                    16, 24, 32, 48, 56, 64, 80, 96, 112, 128, 160, 192,
                    224, 256, 320

                Since stereo encodings necessarily use two audio channels,
                valid stereo bitrates are twice as much as each of the 
                valid mono bitrates, up to the maximum of 320 kbps:
                    32, 48, 64, 96, 112, 128, 160, 192, 224, 256, 320

		For example:
                   A mono encoding might use: -M 3 -B 16 ...
                   A stereo encoding might use: -B 128 ...

                Default: 128 kbps if stereo, or 64 kbps if mono.

                NOTE: Due to details of the encoding process, encoding
                      performed at certain sampling rates prevents the 
                      use of certain bitrates.  If these sampling rates 
                      are used, any illegal bitrates will be adjusted
                      to the closest allowable value.  The actual bitrate
                      and sampling rate used for encoding will be shown
                      in the status display during the encoding process.

                 FOR GIVEN SAMPLING RATE 'x', THE MINIMUM CONSTANT BITRATE IS:
                            x > 32000 Hz      32 kbps (stereo), 24 kbps (mono)
                 32000 Hz > x > 24000 Hz      32 kbps (stereo), 18 kbps (mono)
                 24000 Hz > x > 16000 Hz      32 kbps (stereo), 12 kbps (mono)
                 16000 Hz > x                 32 kbps (stereo), 8 kbps (mono)


-V <scale>      Variable Bit Rate (VBR) scale to encode with;
                Incompatible with -B option.  You cannot use both
                -B and -V modes at the same time.
                
                Instead of encoding at a Constant Bit Rate, VBR 
                encodings vary the bitrate-per-second at which they 
                encode, depending on how many bits per second are 
                necessary to best encode that portion of the sample.
                Quieter or simpler portions of the input sample may
                be encoded with a higher level of compression (reducing
                the file size necessary for that portion), while busier
                or more complicated portions are encoded with a higher 
                bitrate for greater fidelity.

                Xing introduced VBR encoding with AudioCatalyst v1.5 
                and the XingMP3 Encoder v1.5.  Older MP3 players may 
                not playback VBR files correctly; if this is the case,
                upgrade to a more recent MP3 player that supports VBR
                file playback.

                Valid scale values for the VBR encoding mode option are
                0-150. A scale value of 0 effectively uses the highest 
		level of data variability to achieve higher compression, 
		which will result in the smallest MP3 files.  A scale value 
		of 150 uses the lowest level of variable compression, and 
                results in larger files with greater sound 
                fidelity. 

                RECOMMENDED VBR SETTINGS

                VBR Scale = 1
                 Approximate CBR Bitrate (+- 10%) = 96kbit/s
                 Recommended Use: Near CD-Quality (Smallest File Size);
                     Good choice for portable MP3 Players.
                     Use when storage space is a consideration;
                     when playback is performed with low-end sound
                     equipment and listening environment such as
                     portable players or car players.

                VBR Scale = 30
                 Approximate CBR Bitrate (+- 10%) = 112kbit/s
                 Recommended Use: CD-Quality; Best choice for portable MP3
                     Players where file size is limited.

                VBR Scale = 50
                 Approximate CBR Bitrate (+- 10%) = 128kbits
                 Recommended Use: CD-Quality; Best choice for most users.
                     Normal use; Similar to encoding moderately
                     difficult to difficult content with a CBR
                     of 128kbits/s.

                VBR Scale = 75
                 Approximate CBR Bitrate (+- 10%) = 160kbit/s
                 Recommended Use: Archival Quality (Larger File Size);
                     For high-end stereos. Compromise between
                     Normal and High settings.

                VBR Scale = 100
                 Approximate CBR Bitrate (+- 10%) = 192kbit/s
                 Recommended Use: Archival Quality (Unlimited File Size);
                     For highest-end stereos. Use when storage
                     space is not a consideration; when playback
                     is performed with high-end sound equipment
                     and listening environment; and when heavy
                     equalization adjustments might be used
                     on playback.


-M <mode>        Select encoding mode:
                 0        mode-0 simple stereo
                 1        mode-1 joint stereo  (Default)
                 2        dual stereo
                 3        mono

-O <value>       Set original bit:
                 0        Copy
                 1        Original

-C <value>       Set copyright bit:
                 0        Clear copyright bit
                 1        Set copyright bit

-A <algorithm>   Select encoding algorithm:
                 0        Match the sample rate of WAV input file
                          (0 is the Default)
                 1        Use best MPEG-1 sample rate (32, 44.1, 48)
                 2        Use best MPEG-2 sample rate (16, 22.05, 24)
                 xxxxx    Use specified sample rate; valid values are:
                           48000, 44100, 32000, 24000, 22050, 16000

-N              Do not encode high (greater than 16kHz) frequencies.

-Q              Quiet mode: Suppress the printing of statistical output 
                during encoding.  By default, a time estimate meter 
                will be continually updated during the encoding
                process. If you do not want the time estimate meter, 
                use this Quiet mode option.

-S              Instead of displaying the time elapsed/estimated meter,
                periodically display the number of bytes and MPEG data
                frames read and written.

-R              The default return value to the UNIX shell is 0 upon 
                the success of the encoding, and non-0 otherwise.  
                Alternatively, you may use this option to override the 
                default meaning of the return value and return instead 
                the number of MPEG frames that were successfully 
                encoded during the encoding process.

--              Ignore the leading dash on any further command line options;
                force the interpretation of those options as the input and 
                (if specified) output filenames.  Use this if you have an
		input file with a leading dash which you otherwise would have
		a hard time encoding.  Since creating files with such names 
		can wreak havoc when other UNIX utilities are invoked upon
		them, use this option with care!


------------
Known Issues
------------
- When creating stereo MP3 files with a data rate less
  than 56kbps, you must instruct the encoder to select
  the best MPEG2 sample rate (i.e., by including in the
  command line the -A2 parameter). If the -A2 parameter
  is not used, the data rate of the resulting file may
  differ from the data rate specified in the command line.

- When creating mono MP3 files, you should always include
  in the command line the -m3 parameter to insure proper
  results. If the -m3 parameter is not used, the
  characteristics of the resulting file may differ from
  characteristics specified in the command line.

- The "-R" parameter (intended to cause the program to return
  the number of encoded frames upon exit) currently does not work.
                                                                    
- A failed encode will sometimes result in the creation of an invalid
  file.

- When running multiple encode jobs through an automated script,
  incorrect information may occasionally be written to the header of 
  one or more of the resulting MP3 files. This problem has so far been
  observed only when the encode jobs use many different encoder 
  settings and WAV input formats.


-----------------------
Valid Source File Types 
-----------------------

Input WAV files must be 8 or 16 bit data and cannot include non-linear
PCM data.


----------------------------
Producing Quality MPEG Files
----------------------------
Keep in mind that the quality of your MPEG files can never exceed the
quality of your source files, so you should take steps to ensure the
quality of your source files. For example:

- When working with capture hardware, use capture settings that
  produce optimum quality by using the highest data rates available.

- When capturing audio data, you will achieve optimum quality at 44100 
  Hz 16-bit Stereo Audio (CD quality). Look for this option in your
  capture software. Note: Some capture hardware will not capture at
  44100 Hz. In this case, 22050 Hz is an acceptable alternative.


----------------
Technical Support
-----------------
You can obtain Technical Support for the XingMP3 Encoder by accessing
the Support area of our Web site at www.xingtech.com/support/.

From the Support page, you can search the FAQ knowledge base, read 
additional product documentation, and submit problem reports.

Submitting a Problem Report
---------------------------
Telephone support is not available for this product. All Technical 
Support questions must be submitted through a Technical Support problem
report form. If you have not completed the problem report form, your 
request will be returned and you will be asked to fill out the 
appropriate problem report so that our support staff will have 
necessary system and program configuration to address your issue as
quickly as possible.

Technical Support questions submitted to Customer Service or through
Contact Xing, must be re-routed to our Technical Support department. 
Re-routing results in delaying our response time to you. 

MP3 Users List
--------------
Xing has set up a users list for general discussion regarding 
AudioCatalyst, the StreamWorks MP3 Server, the Xing MP3Live! Encoder,
the XingMP3 Encoder, the XingMP3 Player, and issues related to MPEG 
Layer 3 audio. While the Users List is monitored by Xing's support 
staff, it is not intended to be a Technical Support forum.

For information on subscribing to the MP3 Users List, visit:
     http://www.xingtech.com/support/mp3users.html

