wmdimp 0.3 INSTALL -- Daniele Tamino <aslo@wmdimp.cjb.net>

REQUIREMENTS

To build wmdimp, you need to have installed all the basic development
tools, such as a c compiler (gcc) and make. If you plan to hack with
it, maybe some other tools like m4, automake, autoheader and autoconf
wouldn't be bad too.

To compile the libmad player, you need libmad (of course!) and the
libmad headers, libid3tag, and libz because libmad requires it. You can find
it at:
   http://www.mars.org/home/rob/proj/mpeg/
Note that if you use binary packages such as .rpm or .deb, you'll need the
'devel' version too, to compile wmdimp.

If you compiled the mpg123 player, maybe you want to install mpg123 if
you plan to listen something. You can find it at:
   http://www-ti.informatik.uni-tuebingen.de/~hippm/mpg123.html
Or you can use other players compatible with mpg123 such as mpg321:
   http://sourceforge.net/projects/mpg321

INSTALLATION

first run configure:

      ./configure <options>

Usually no option is necessary, so just run "./configure".

You can specify where to install the binary with

      ./configure --prefix="/path/to/install" <options>
      
(default: /usr/local/bin)

The options recognized are:

  --enable-errdiff: use error diffusion dithering instead of random
    dithering when it is enabled. It's a bit faster, and sometimes even
    sounds better, but it seems that random dithering is better... you
    may experiment (default: no, use random dithering).
    N.B. When dithering is enabled, it does even a 3rd order noise
    shaping, with both kinds.

  --with-libmad: compile the internal mp3 player based on libmad. This one
    has many advantages compared with the the mpg123 wrapper, such as
    buffering, dithering, complete id3 tag info, more overall control,
    but it can output only to oss or a raw file (or pipe).
    (default: yes)

  --with-mpg123: compile the player based on the external mpg123
    program. You may want to use mpg123 if you have special
    requirements (i.e. want to use esd or arts, or alsa, since wmdimp
    doesn't support them yet), because you don't want to install
    libmad for some reason, or just because the internal player
    doesn't work... in this case send me a bug report and I'll try to
    fix it if I can. 
    (default: no if using the libmad player, else yes)

  --enable-debugging: enables debugging information and internal
    debugging code (useful only if you are a developer or you want to
    help discovering some bugs :-)
    (default: no).

  --enable-profiling: enables compilation for profiling (with gprof
    and similar tools), and sets appropriate compiler options. This
    also reduces optimizations if debugging is not selected, and
    enables some debugging info needed for profiling
    (default: no).

(Type ./configure --help for more options)

then, compile:

       make
      
if you want, you can test it now:

       ./wmdimp

Without a configuration file, it will load all .mp3 files in the
current directory (if any), with the default settings. Right-click on
the stop button to terminate it.
      
To install it (as root, usually):

       make install

Now you can run it simply typing "wmdimp" from the command line (if the
installation directory "<prefix>/bin" was in your PATH).
However, before you should create a configuration file: use sample.wmdimprc
as a start point:

        cp sample.wmdimprc ~/.wmdimprc

and then edit it to suits your needs (you'll find instructions
inside).
There is also a man page for wmdimprc, generated from sample.wmdimprc
('man wmdimprc').

Enjoy!

   Daniele
