Make your own free website on Tripod.com
BladeEnc Manual

BladeEnc
Blade's MP3 Encoder
version 0.88
Release Date: December 5, 1999

written by Tord Jansson,
based on source code from ISO

E-mail: tord.jansson@swipnet.se
Homepage: http://bladeenc.mp3.no

This manual is written for the Windows version of BladeEnc.
Various ports may differ slightly in some aspects (but normally they don't).










Disclaimer

BladeEnc is distributed 'as is' with no warranty of any kind. The Author is not to be held responsible for any use or misuse of this product or the result thereof.
 

Short Description

BladeEnc is a program to generate MP3 files from WAV, AIFF or RAW sound files. BladeEnc is available for most modern computer platforms, including Windows, Linux, BeOS, UnixWare, Solaris, FreeBSD, NetBSD, OpenBSD, OS/2 and many more.

BladeEnc is free software distributed under the LGPL license and the sourcecode is available from my homepage for those who might be interested.

Windows users will find that it looks like a DOS-program, but it is in fact a true 32-bit Windows application that supports long filenames etc. This text based interface might be a bit harder for the beginner, but makes it easy to make automated scripts (like BAT-files) to perform your tasks and makes BladeEnc a doodle to port to all modern operating systems except Mac. A large selection of graphical frontends are available from my homepage for those who prefer to do their encoding just by moving and clicking their mouse.

On my homepage you can also find some more detailed information about BladeEnc, including a FAQ (answers to Frequently Asked Questions), speed comparisons with other encoders and information about the quality of MP3s generated by BladeEnc.

You can also go to the link section of my homepage if you want some more information about MP3 in general or needs an MP3 Player.
 

Quick-Start Guide

If you just want to turn your WAV/AIFF-files into standard 128 kBit stereo MP3 files, just drag and drop your files onto BladeEnc.exe (that is the BladeEnc ICON and not the window that opens if you double click it).

Once started, BladeEnc will encode the files one by one until finished, which is a process that can take several hours.

BladeEnc can be stopped any time during the process by pressing CTRL-C (all systems) or ESC (Windows & OS/2 only).

The resulting MP3-files are put in the same directory as their corresponding WAV/AIFF-files.
 

The More Advanced Users Guide

BladeEnc is despite its primitive appearance both powerful and easy to use. It is a console application that takes its parameters from the commandline. The commandline is where you enter text commands to your computer, the DOS-Prompt and "Start->Run.."-menu on a Windows system are examples of commandlines.

Any number of WAV/AIFF-files can be specified on the commandline and you can even use wildcards to specify more than one file at the same time. For example will the command "BladeEnc *.wav" compress all WAV-files in the current directory. Long filenames are supported when entering them on the commandline, but if they include space-characters you will have to enclose the names with quotation-marks ( " ).

Switches can be entered on the commandline together with the filenames. In earlier versions of BladeEnc it didn't matter where you put the switches since they always affected all files anyway, but from BladeEnc 0.80 this has changed in order to give you more flexibility.

You can get a list of all valid arguments by running BladeEnc without any commandline arguments (for example by double-clicking on its icon).

If you feel that you need a temporary performance boost to your system you can pause the process by pressing ESC (Windows & OS/2) or CTRL-Z (Linux and other UNICES).

To run BladeEnc from the commandline you should place BladeEnc.exe where your system automatically finds it, for example your Windows directory.
 

The Configuration File

The default settings of BladeEnc can be changed in the configuration file. On Windows systems this configuration file is called bladeenc.cfg and should always be placed in the same directory as BladeEnc.exe. On a Unix system it is called .bladeencrc and should be placed in your home directory.

The config file contains the same kind of switches as you enter on the commandline, separated by one or more spaces, tabs or newlines.

Anything placed after a '#' until the end of the line is believed to be a comment and is ignored.

The switches in the configuration file are simply appended to the beginning of the commandline before it is parsed.

Anything typed on the commandline has higher priority that what is in the configuration file, so the default settings can easily be overriden from the commandline.

If the -nocfg switch is entered on the commandline the configuration file will be ignored. The -nocfg switch is not allowed in the configuration file.
 

The Structure of The Commandline Arguments

The way the commandline is interpreted by BladeEnc has changed in version 0.80 in order to make it all more flexible and powerful and should work nicely with most older frontends. Also, the l3enc emulation mode has been removed, so it doesn't distinguish between l3enc- and BladeEnc commandlines anymore, but should be able to understand both anyway.

On the commandline you specify the files you want to encode, together with any switches to control the process and optionally the name of the output files. Most switches can be applied both globally, which makes them affect all the files, or locally, which makes them affect only one file.
Switches that only affects the general behaviour of BladeEnc and don't affect the output of the encoding process, can only be specified globally (like -quiet).

The commandline is read by BladeEnc following these simple rules:
 

  1. Files to be encoded are specified on the commandline.

  2.  

    Example:  bladeenc track1.wav track2.wav will first encode the file track1.wav and then track2.wav.
     
     
     

  3. If an input file is immediately followed by a filename ending with ".mp3" that will be the output name of the encoded file. If it isn't followed by a filename ending with ".mp3", the output file will get the same name as the input file, but substituting the extension with ".mp3".

  4.  

    Example:  bladeenc track1.wav track2.wav output2.mp3 will first encode track1.wav into track1.mp3 and then encode track2.wav into output2.mp3.
     
     
     

  5. Switches that are placed before the first input file are considered global and will affect all the specified files.

  6.  

    Example:  bladeenc -crc -160 track1.wav track2.wav will generate 160 kBit MP3 files with checksums of both input files.
     
     
     

  7. Switches that are placed anywhere else will only affect the preceding input file.

  8.  

    Example:  bladeenc track1.wav -crc -160 track2.wav -mono will generate a 160 kBit MP3 file with embedded checksum of track1.wav and a 128 kBit mono MP3 file of track2.wav (128 kBit is the default bitrate).
     
     
     

  9. Local switches have higher priority than global switches.

  10.  

    Example:  bladeenc -160 track1.wav -256 track2.wav will generate a 256 kBit mp3 file of track1.wav and a 160 kBit mp3 file of track2.wav.
     
     
     

  11. Local switches must be placed after any specified output file. They may not be placed between the input and output file.

  12.  

    Example:  bladeenc track1.wav output1.mp3 -256 will work just fine, but bladeenc track1.wav -256 output1.mp3 will just confuse bladeenc and generate an error message.
     
     
     

  13. Stdin can be specified as input by simply substituting the name of the input file with stdin. This will make bladeenc read the input from a redirection or pipe instead.

  14.  

    Example: bladeenc stdin output.mp3 will encode the file coming through stdin and put the result in output.mp3.
     
     
     

  15. Stdout can be specified as output by simply substituting the name of the output file with stdout. This will make bladeenc send the  generated MP3 file through the standard output stream.

  16.  

    Example:  bladeenc track1.wav stdout will encode track1.wav and send the mp3 file through the standard output stream.
     
     
     

  17. And all this can be combined into one big operation.

  18.  

    Example: bladeenc -160 track1.wav stdout -mono track2.wav track3.wav output.mp3 -crc stdin stdout -112 will do all the following: Encode track1.wav into a 160 kBit mono mp3 that is sent to stdout. Encode track2.wav into a 160 kBit mp3 named track2.mp3. Encode track3.wav into a 160 kBit mp3 with CRC named output.mp3. Encode what comes through the stdin into a 112 kBit mp3 that is appended to the data that is already sent to stdout.


Commandline Switches

All commandline switches are case-insensitive, so you can enter them in either upper- or lower-case.
 
-[bitrate],
-br [bitrate]
Defines the bitrate for the MP3-file. Higher bitrates gives better quality, but also bigger files. Most people prefer to generate 128 kBit MP3s. Please note that it's the total bitrate that is specified, so if you're generating a stereo MP3-file at 128 kBit you get 64 kBit for left channel and 64 kBit for the right channel. The default setting is 128 kBit for stereo files and 64 kBit for mono files. 

Allowed bitrates are: 32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256 and 320.

-crc Adds checksum data to each frame in the MP3 file. The checksum data is useful for error-correction when streaming the MP3 in realtime over internet (as done by internet radio stations). It lowers the quality of the sound slightly since the checksum data also needs to fit in the specified bitrate and is not needed for normal use.
-delete,
-del
The WAV-file is automatically deleted after having been encoded. Be careful with this switch because the WAV-file is deleted even if the encoding process failed (for example due to insufficient drive space).
-mono,
-dm
Downmixes stereo input files to mono before they are compressed, thus generating mono MP3 files. This switch does nothing if the input file already is mono.
-leftmono,
-lm
Takes only the left channel of the input file and encodes it into a mono MP3. If the input file is mono it will be compressed as it is.
-rightmono,
-rm
Takes only the right channel of the input file and encodes it into a mono MP3. If the input file is mono it will be compressed as it is.
-swap Swaps the left and right channels of stereo input files before encoding them. 
-private,
-p
Sets the private-flag in the MP3-file, specifying that this is a private MP3. As far as I know there is no program that treats private MP3's differently from normal ones so it is practically useless. 

Setting this flag doesn't affect the encoding time, file size or quality in any way, so set it if it makes you happy.

-copyright,
-c
Sets the copyright-flag in the MP3-file, specifying that this is a copyrighted MP3. As far as I know there is no program that treats copyrighted MP3's differently from normal ones so it is practically useless. 

Setting this flag doesn't affect the encoding time, filesize or quality in any way, so set it if it makes you happy.

-copy This switch clears the MP3 file's original-flag that is set by default from version 0.50 of BladeEnc. 

Clearing the original-flag doesn't affect the encoding time, filesize or quality in any way, so do it if it makes you happy.

-quiet Prevents BladeEnc from doing any screen output, except for error messages. This is mostly useful if you want to run bladeenc as a background process on UNIX systems. The screen output takes nearly no time at all, so you won't even save 1% by disabling screen output. This switch is global only.
-quit,
-q
Makes BladeEnc quit automatically when all files have been encoded. Normally BladeEnc waits for someone to press RETURN before quitting. This switch is global only.
-outdir=[path] Specifies an output path for the encoded files. Normally the MP3 files ends up in the same directory as their corresponding WAV-files resides in, but using this switch you can get them to end up wherever you like. This switch is global only.
-prio=[setting] Changes the task priority of BladeEnc. Valid settings are HIGHEST, HIGHER, NORMAL, LOWER, LOWEST and IDLE. BladeEnc is by default set to LOWEST priority which basically means that BladeEnc functions fine in the background without disturbing or slowing down any other program. Linux/Unix users can also specify prio in the normal unix range of -20 to +20.This switch is global only.
This setting is not available in all ports.
-rawfreq=[frequency] Specifies the frequency for raw samples in hertz. Default is 44100.
-rawbits=[samplebits] Specifies the number of bits for each sample in a raw sample file. Allowed values are 8 and 16. Default is 16.
-rawmono Specifies that raw samples are mono, not stereo.
-rawstereo Specifies that raw samples are stereo, not mono. This is default, so you won't have to use this switch unless you want to override a global -rawmono switch.
-rawsigned Specifies that raw samples are signed, i.e. contains values in the range -32768 to +32767 (16-bit samples) or -128 to +127 (8-bit samples). This is default, so you won't have to use this switch unless you want to override a global -rawunsigned switch.
-rawunsigned Specifies that raw samples are unsigned, i.e. contains values in the range 0 to 65535 (16-bit samples) or 0 to 255 (8-bit samples).
-rawbyteorder=[LITTLE/BIG] Specifies the byteorder of raw samples. LITTLE gives LITTLE_ENDIAN (Intel x86 style) and BIG gives BIG_ENDIAN (Motorola style). Default is whatever is the native byteorder for your system, so hopefully you won't have to use this switch.
-rawchannels=[1/2] Specifies the number of channels in a raw sample. -rawchannels=1 gives the same result as -rawmono and -rawchannels=2 give the same result as -rawstereo. Default is 2.
-nocfg Ignore whatever is specified in the config file. This switch is global only.
-refresh=[1+] Sets the refresh rate of the progress indicator. Higher values gives lower refreshrates. By lowering the refreshrate you will make BladeEnc run slightly faster. Default is 2 which should be ok for most systems. However, users who run BladeEnc on a server through a terminal should lower the value a bit to decrease network traffic. This switch is global only.
-progress=[0-8] Specifies which of the 7 available progress indicators to use or turns the progress indicator off if set to 0. The default progress indicator is number 1. Changing the progress indicator doesn't affect the encoding in any way it just lets you configure the look of BladeEnc a little bit according to your own taste:

  1. Percentage and ETA shown for file and batch (default).
  2. Long bar for file progress.
  3. Long bar for batch progress.
  4. Short bars for file and batch progress.
  5. Samples done/total for file and batch.
  6. ETA shown for file and batch.
  7. Seconds of MP3 generated from file (default for RAW samples).
  8. Alternative long bar for file progress. Doesn't rewind the cursor so it produces less output and works well when redirecting program output to a file.
If a RAW sample is included in the batch you automatically gets progress indicator 7 for technical reasons. enum { PROG_OFF, PROG_BOTH_PERC_ETA, PROG_FILE_GRAPH, PROG_BATCH_GRAPH, PROG_BOTH_GRAPH, PROG_BOTH_SAMPLES, PROG_BOTH_ETA, PROG_FILE_RLEN, PROG_FILE_NORETURN, }; This switch is global only.

L3Enc Emulation Mode

The l3enc emulation mode of older versions of BladeEnc has been removed in BladeEnc 0.80 since the new way of reading the commandline in this version makes it understand l3enc commandlines anyway.

Just remember that the default bitrate of BladeEnc is 128 kBit, while l3enc uses 112 kBit.

However, two small tricks were necessary to make BladeEnc compatible with l3enc:

  1. If the specified bitrate is over 1000 it is divided by 1000 in order to convert it from bits/sec to kBit/sec.
  2. If l3enc's -hq switch is placed on the commandline or a bitrate over 1000 is specified locally using the -br switch, BladeEnc automatically activates the -quit switch.


Updates, Questions and Information

The latest version of BladeEnc is available at my homepage together with an FAQ and some other information. See the top of this document for the URL and my E-mail address. Please only e-mail me if you can't find the info you want on my homepage.
 

Copyright and Distribution

BladeEnc is copyright Tord Jansson.

BladeEnc is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

You should have received a copy of the GNU Lesser General Public License with BladeEnc. If not, please see BladeEnc's homepage or www.fsf.org for more details.
 

Credits

BladeEnc includes code from distribution 10 of ISO's reference code. Known contributors to that reference code have been:

Bill Aspromonte,  Shaun Astarabadi,  R. Bittner,  Karlheinz Brandenburg,  W. Joseph Carter,  Jack Chang,  Mike Coleman,  Johnathan Devine,  Ernst Eberlein,  Dan Ellis,  Peter Farrett,  Jean-Georges Fritsch,  Vlad Fruchter,  Hendrik Fuchs,  Bernhard Grill, Amit Gulati,  Munsi Haque,  Chuck Hsiao,  Toshiyuki Ishino,  Masahiro Iwadare,  Earl Jennings,  James Johnston,  Leon v.d. Kerkhof,  Don Lee,  Mike Li,  Yu-Tang Lin,  Soren Neilsen,  Simao F. Campos Neto,  Mark Paley,  Davis Pan,  Tan Ah Peng,  Kevin Peterson,  Juan Pineda,  Ernst F. Schroeder,  Peter Siebert,  Jens Spille,  Sam Stewart,  Al Tabayoyon,  Kathy Wang,  Franz-Otto Witte,  Douglas Wong.

All modifications of the reference code in order to create all versions of BladeEnc up to 0.80 have been made by Tord Jansson.
 

Thanks to the following people for contributing code and bugfixes to BladeEnc:

Mikael Kjellström, Kevin Doherty, Milan Hodoscek, Wesley Hosking, Jon Watte, Dmitri Kalintsev, William Thompson, Olaf Pueschel, Marc Schefer, Lennart Börjeson, John DuBois.
 

Thanks to the following people for providing binaries of BladeEnc for various formats:

Trevor Phillips, Zac Livingston, Jon Coyle, Alexey Marinichev, Mikael Kjellström, Steve Burns, Markus Ridinger, Giao Nguyen, Joel Fredrikson, Marca Registrada, Rob Braun.