Update readme

This commit is contained in:
bnnm 2017-05-01 17:33:50 +02:00
parent 24d8e228c7
commit 6763744597

View File

@ -1,24 +1,26 @@
vgmstream
This is vgmstream, a library for playing streamed audio from video games.
It is very much under development. There are multiple end-user bits: a command
line decoder called "test.exe", a Winamp plugin called "in_vgmstream", a
foobar2000 component called "foo_input_vgmstream", and an xmplay plugin
called "xmp-vgmstream".
There are multiple end-user bits:
- a command line decoder called "test.exe"
- a Winamp plugin called "in_vgmstream"
- a foobar2000 component called "foo_input_vgmstream"
- an XMPlay plugin called "xmp-vgmstream"
- an Audacious plugin called "libvgmstream"
*********** IMPORTANT!! ***********
--- needed files (for Windows) ---
Since Ogg Vorbis, MPEG audio, and other formats are now supported, you will
need to have certain DLL files.
You can get these from https://f.losno.co/vgmstream-win32-deps.zip, or in
the case of the foobar2000 component, they are all bundled for convenience.
In the case of the foobar2000 component they are all bundled for convenience,
or you can get them from here: https://github.com/kode54/vgmstream
(also here: https://f.losno.co/vgmstream-win32-deps.zip, may not be latest).
Put libvorbis.dll, libmpg123-0.dll, libg7221_decode.dll, libg719_decode.dll,
at3plusdecoder.dll, avcodec-vgmstream-57.dll, avformat-vgmstream-57.dll, and
avutil-vgmstream-55.dll somewhere Windows can find them.
For in_vgmstream this means in the directory with winamp.exe, or in a
system directory or other directory in the PATH variable. For test.exe this
means in the same directory as test.exe, or in a system directory/PATH.
For Winamp/XMPlay/test.exe this means in the directory with the .exe, or in a
system directory, or other directory in the PATH variable.
--- test.exe ---
Usage: ./test [-o outfile.wav] [-l loop count]
@ -50,6 +52,14 @@ to decode happy.adx to happy.wav.
Drop the in_vgmstream.dll in your Winamp plugins directory. Please follow
the above instructions for installing the other files needed.
--- xmp-vgmstream ---
Drop the xmp-vgmstream.dll in your XMPlay plugins directory. Please follow
the above instructions for installing the other files needed.
--- foo_input_vgmstream ---
Every should be installed automatically by the .fb2k-component bundle.
--- File types supported by this version of vgmstream ---
As manakoAT likes to say, the extension doesn't really mean anything, but it's
@ -239,8 +249,9 @@ multi:
- .strm (NDS IMA ADPCM, 8/16 bit PCM)
- .ss7 (EACS IMA ADPCM, IMA ADPCM)
- .swav (NDS IMA ADPCM, 8/16 bit PCM)
- .xwb (16 bit PCM, Xbox IMA ADPCM)
- .xwb (PCM, Xbox IMA ADPCM, MS ADPCM, XMA, XWMA, ATRAC3)
- .wav, .lwav (unsigned 8 bit PCM, 16 bit PCM, GC DSP ADPCM, MS IMA ADPCM)
- .wem (PCM, Wwise Vorbis, Wwise ADPCM, XMA, XWMA, GC DSP ADPCM)
etc:
- .2dx9 (MS ADPCM)
@ -260,9 +271,11 @@ etc:
- .hca (CRI)
- .kcey (EACS IMA ADPCM)
- .lsf (LSF ADPCM)
- .mc3 (Paradigm MC3 ADPCM)
- .mwv (Level-5 0x555 ADPCM)
- .mtaf (Konami ADPCM)
- .ogg, .logg (Ogg Vorbis)
- .ogl (Shin'en Vorbis)
- .p3d (Radical ADPCM)
- .rsf (CCITT G.721 ADPCM)
- .sab (Worms 4 soundpacks)