2017-10-09 04:08:04 +02:00
|
|
|
# vgmstream
|
|
|
|
|
2019-01-17 02:34:40 +01:00
|
|
|
[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/losnoco/vgmstream?branch=master&svg=true "Build Status")](https://ci.appveyor.com/project/kode54/vgmstream/branch/master/artifacts)
|
2018-01-20 04:47:34 +01:00
|
|
|
|
|
|
|
|
2017-12-24 01:30:57 +01:00
|
|
|
This is vgmstream, a library for playing streamed (pre-recorded) audio
|
|
|
|
from video games.
|
2017-10-09 04:08:04 +02:00
|
|
|
|
|
|
|
There are multiple end-user bits:
|
2017-12-28 22:30:45 +01:00
|
|
|
- a command line decoder called "test.exe/vgmstream-cli"
|
2017-10-09 04:08:04 +02:00
|
|
|
- a Winamp plugin called "in_vgmstream"
|
|
|
|
- a foobar2000 component called "foo_input_vgmstream"
|
|
|
|
- an XMPlay plugin called "xmp-vgmstream"
|
|
|
|
- an Audacious plugin called "libvgmstream"
|
2017-12-28 22:30:45 +01:00
|
|
|
- a command line player called "vgmstream123"
|
2017-10-09 04:08:04 +02:00
|
|
|
|
2017-12-24 01:30:57 +01:00
|
|
|
Help and newest builds can be found here: https://www.hcs64.com/
|
|
|
|
|
2019-01-17 02:34:40 +01:00
|
|
|
Latest development is usually here: https://github.com/losnoco/vgmstream/
|
2017-12-24 01:30:57 +01:00
|
|
|
|
2019-09-15 15:47:41 +02:00
|
|
|
You can find further info about other details in https://github.com/losnoco/vgmstream/tree/master/doc
|
|
|
|
|
2017-12-24 01:30:57 +01:00
|
|
|
## Needed extra files (for Windows)
|
|
|
|
Support for some codecs (Ogg Vorbis, MPEG audio, etc) is done with external
|
|
|
|
libraries, so you will need to have certain DLL files.
|
2017-11-24 21:01:28 +01:00
|
|
|
|
2017-10-09 04:08:04 +02:00
|
|
|
In the case of the foobar2000 component they are all bundled for convenience,
|
2019-01-17 02:34:40 +01:00
|
|
|
or you can get them here: https://github.com/losnoco/vgmstream/tree/master/ext_libs
|
2017-12-24 01:30:57 +01:00
|
|
|
(bundled here: https://f.losno.co/vgmstream-win32-deps.zip, may not be latest).
|
2017-10-09 04:08:04 +02:00
|
|
|
|
2018-08-12 22:59:38 +02:00
|
|
|
Put the following files somewhere Windows can find them:
|
|
|
|
- `libvorbis.dll`
|
|
|
|
- `libmpg123-0.dll`
|
|
|
|
- `libg7221_decode.dll`
|
|
|
|
- `libg719_decode.dll`
|
|
|
|
- `avcodec-vgmstream-58.dll`
|
|
|
|
- `avformat-vgmstream-58.dll`
|
|
|
|
- `avutil-vgmstream-56.dll`
|
|
|
|
- `swresample-vgmstream-3.dll`
|
|
|
|
- `libatrac9.dll`
|
|
|
|
- `libcelt-0061.dll`
|
|
|
|
- `libcelt-0110.dll`
|
2017-11-24 21:01:28 +01:00
|
|
|
|
2017-12-28 22:30:45 +01:00
|
|
|
For Winamp/XMPlay/command line this means in the directory with the main .exe,
|
|
|
|
or in a system directory, or any other directory in the PATH variable.
|
2017-10-09 04:08:04 +02:00
|
|
|
|
2019-03-04 00:06:05 +01:00
|
|
|
|
|
|
|
## Components
|
|
|
|
|
2017-12-28 22:30:45 +01:00
|
|
|
### test.exe/vgmstream-cli
|
2019-03-04 00:06:05 +01:00
|
|
|
*Installation*: unzip the file and follow the above instructions for installing
|
|
|
|
the other files needed.
|
|
|
|
|
|
|
|
Converts playable files to wav. Typical usage would be:
|
|
|
|
- `test.exe -o happy.wav happy.adx` to decode `happy.adx` to `happy.wav`.
|
2017-10-09 04:08:04 +02:00
|
|
|
|
2019-03-04 00:06:05 +01:00
|
|
|
If command-line isn't your thing you can also drag and drop files to the
|
|
|
|
executable to decode them as (filename).wav
|
|
|
|
|
|
|
|
There are multiple options that alter how the file is converted, for example:
|
|
|
|
- `test.exe -m -o file.wav file.adx`: print info but don't decode
|
|
|
|
- `test.exe -i -o file.wav file.hca`: convert without looping
|
|
|
|
- `test.exe -s 2 -F -o file.wav file.fsb`: play 2nd subsong + ending after 2.0 loops
|
|
|
|
- `test.exe -l 3.0 -f 5.0 -d 3.0 -o file.wav file.wem`: 3 loops, 3s delay, 5s fade
|
|
|
|
|
|
|
|
Available commands are printed when run with no flags. Note that you can also
|
|
|
|
achieve similar results for other plugins using TXTP, described later.
|
2018-01-05 00:57:00 +01:00
|
|
|
|
2017-10-09 04:08:04 +02:00
|
|
|
### in_vgmstream
|
2019-03-04 00:06:05 +01:00
|
|
|
*Installation*: drop the ```in_vgmstream.dll``` in your Winamp plugins directory,
|
|
|
|
and follow the above instructions for installing the other files needed.
|
|
|
|
|
|
|
|
Once installed supported files should be playable.
|
2017-10-09 04:08:04 +02:00
|
|
|
|
|
|
|
### xmp-vgmstream
|
2019-03-04 00:06:05 +01:00
|
|
|
*Installation*: drop the ```xmp-vgmstream.dll``` in your XMPlay plugins directory,
|
|
|
|
and follow the above instructions for installing the other files needed.
|
2017-10-09 04:08:04 +02:00
|
|
|
|
2019-03-04 00:06:05 +01:00
|
|
|
Note that this has less features compared to in_vgmstream and has no configuration.
|
|
|
|
Since XMPlay supports Winamp plugins you may also use ```in_vgmstream.dll``` instead.
|
2017-10-09 04:08:04 +02:00
|
|
|
|
|
|
|
Because the XMPlay MP3 decoder incorrectly tries to play some vgmstream exts,
|
|
|
|
you need to manually fix it by going to **options > plugins > input > vgmstream**
|
2019-03-04 00:06:05 +01:00
|
|
|
and in the "priority filetypes" put: `ahx,asf,awc,ckd,fsb,genh,msf,p3d,rak,scd,txth,xvag`
|
2017-10-09 04:08:04 +02:00
|
|
|
|
2017-12-03 17:27:27 +01:00
|
|
|
### foo_input_vgmstream
|
2019-03-04 00:06:05 +01:00
|
|
|
*Installation*: every file should be installed automatically by the `.fb2k-component`
|
|
|
|
bundle.
|
|
|
|
|
|
|
|
A known quirk is that when loop options or tags change, playlist won't refresh
|
|
|
|
automatically. You need to manually refresh it by selecting songs and doing
|
|
|
|
**shift + right click > Tagging > Reload info from file(s)**.
|
2017-10-09 04:08:04 +02:00
|
|
|
|
2017-12-03 17:27:27 +01:00
|
|
|
### Audacious plugin
|
2019-03-04 00:06:05 +01:00
|
|
|
*Installation*: needs to be manually built. Instructions can be found in the BUILD
|
2019-10-06 23:31:32 +02:00
|
|
|
document in vgmstream's source code.
|
2017-10-09 04:08:04 +02:00
|
|
|
|
2017-12-28 22:30:45 +01:00
|
|
|
### vgmstream123
|
2019-10-06 23:31:32 +02:00
|
|
|
*Installation*: needs to be manually built. Instructions can be found in the BUILD
|
|
|
|
document in vgmstream's source code.
|
2018-01-05 00:57:00 +01:00
|
|
|
|
2019-03-04 00:06:05 +01:00
|
|
|
Usage: `vgmstream123 [options] INFILE ...`
|
2018-01-05 00:57:00 +01:00
|
|
|
|
|
|
|
The program is meant to be a simple stand-alone player, supporting playback
|
|
|
|
of vgmstream files through libao. Files compressed with gzip/bzip2/xz also
|
|
|
|
work, as identified by a .gz/.bz2/.xz extension. The file will be decompressed
|
|
|
|
to a temp dir using the respective utility program (which must be installed
|
|
|
|
and accessible) and then loaded.
|
|
|
|
|
|
|
|
It also supports playlists, and will recognize a special extended-M3U tag
|
|
|
|
specific to vgmstream of the following form:
|
|
|
|
```
|
|
|
|
#EXT-X-VGMSTREAM:LOOPCOUNT=2,FADETIME=10.0,FADEDELAY=0.0,STREAMINDEX=0
|
|
|
|
```
|
|
|
|
(Any subset of these four parameters may appear in the line, in any order)
|
|
|
|
|
|
|
|
When this "magic comment" appears in the playlist before a vgmstream-compatible
|
|
|
|
file, the given parameters will be applied to the playback of said file. This makes
|
|
|
|
it feasible to play vgmstream files directly instead of needing to make "arranged"
|
|
|
|
WAV/MP3 conversions ahead of time.
|
|
|
|
|
|
|
|
The tag syntax follows the conventions established in Apple's HTTP Live Streaming
|
|
|
|
standard, whose docs discuss extending M3U with arbitrary tags.
|
2017-12-28 22:30:45 +01:00
|
|
|
|
2018-01-07 20:13:42 +01:00
|
|
|
|
|
|
|
## Special cases
|
2018-10-20 14:54:49 +02:00
|
|
|
vgmstream aims to support most audio formats as-is, but some files require extra
|
2018-01-07 20:13:42 +01:00
|
|
|
handling.
|
|
|
|
|
|
|
|
### Renamed files
|
|
|
|
A few extensions that vgmstream supports clash with common ones. Since players
|
2018-10-20 14:54:49 +02:00
|
|
|
like foobar or Winamp don't react well to that, they may be renamed to make
|
|
|
|
them playable through vgmstream.
|
|
|
|
- .aac to .laac (tri-Ace games)
|
|
|
|
- .ac3 to .lac3 (standard AC3)
|
2019-04-07 01:47:07 +02:00
|
|
|
- .aif to .laif or .aiffl or .aifcl (standard Mac AIF, Asobo AIF, Ogg)
|
|
|
|
- .aiff/aifc to .aiffl/aifcl (standard Mac AIF)
|
2019-01-20 00:50:39 +01:00
|
|
|
- .asf to .lasf (EA games, Argonaut ASF)
|
2019-09-08 21:16:04 +02:00
|
|
|
- .bin to .lbin (various)
|
2018-10-20 14:54:49 +02:00
|
|
|
- .flac to .lflac (standard FLAC)
|
|
|
|
- .mp2 to .lmp2 (standard MP2)
|
|
|
|
- .mp3 to .lmp3 (standard MP3)
|
|
|
|
- .mp4 to .lmp4 (standard M4A)
|
|
|
|
- .mpc to .lmpc (standard MPC)
|
|
|
|
- .ogg to .logg (standard OGG)
|
|
|
|
- .opus to .lopus (standard OPUS or Switch OPUS)
|
|
|
|
- .stm to .lstm (Rockstar STM)
|
|
|
|
- .wav to .lwav (standard WAV)
|
|
|
|
- .wma to .lwma (standard WMA)
|
|
|
|
- .(any) to .vgmstream (FFmpeg formats or TXTH)
|
2019-10-06 23:31:32 +02:00
|
|
|
|
2018-01-07 20:13:42 +01:00
|
|
|
Command line tools don't have this restriction and will accept the original
|
|
|
|
filename.
|
|
|
|
|
2018-10-20 14:54:49 +02:00
|
|
|
The main advantage to rename them is that vgmstream may use the file's
|
|
|
|
internal loop info, or apply subtle fixes, but is also limited in some ways
|
2019-10-06 23:31:32 +02:00
|
|
|
(like standard/player's tagging). .vgmstream is a catch-all extension that
|
|
|
|
may work as a last resort to make a file playable.
|
2018-10-20 14:54:49 +02:00
|
|
|
|
2019-10-06 23:31:32 +02:00
|
|
|
Some plugins have options that allow any extension (common or unknown) to be
|
|
|
|
played, making renaming is unnecessary (may need to adjust plugin priority in
|
|
|
|
player's options).
|
2018-10-20 14:54:49 +02:00
|
|
|
|
2019-11-02 16:02:53 +01:00
|
|
|
Also be aware that some plugins can tell the player they handle some extension,
|
|
|
|
then not actually play it. This makes the file unplayable as vgmstream doesn't
|
|
|
|
even get the chance to parse that file, so you may need to disable the offending
|
|
|
|
plugin or rename the file (for example this may happen with .asf and foobar).
|
|
|
|
|
2018-10-20 14:54:49 +02:00
|
|
|
When extracting from a bigfile, sometimes internal files don't have an actual
|
2018-01-07 20:13:42 +01:00
|
|
|
name+extension. Those should be renamed to its proper/common extension, as the
|
|
|
|
extractor program may guess wrong (like .wav instead of .at3 or .wem). If
|
2018-10-20 14:54:49 +02:00
|
|
|
there is no known extension, usually the header id string may be used instead.
|
|
|
|
|
|
|
|
Note that vgmstream also accepts certain extension-less files too.
|
|
|
|
|
|
|
|
### Demuxed videos
|
|
|
|
vgmstream also supports audio from videos, but usually must be demuxed (extracted
|
|
|
|
without modification) first, since vgmstream doesn't attempt to support them.
|
|
|
|
|
|
|
|
The easiest way to do this is using VGMToolBox's "Video Demultiplexer" option
|
|
|
|
for common game video formats (.bik, .vp6, .pss, .pam, .pmf, .usm, .xmv, etc).
|
|
|
|
|
|
|
|
For standard videos formats (.avi, .mp4, .webm, .m2v, .ogv, etc) not supported
|
|
|
|
by VGMToolBox FFmpeg binary may work:
|
|
|
|
- `ffmpeg.exe -i (input file) -vn -acodec copy (output file)`
|
|
|
|
Output extension may need to be adjusted to some appropriate audio file depending
|
|
|
|
on the audio codec used. ffprobe.exe can list this codec, though the correct audio
|
|
|
|
extension depends on the video itself (like .avi to .wav/mp2/mp3 or .ogv to .ogg).
|
2018-01-07 20:13:42 +01:00
|
|
|
|
2018-10-20 14:54:49 +02:00
|
|
|
Some games use custom video formats, demuxer scripts in .bms format may be found
|
|
|
|
on the internet.
|
|
|
|
|
|
|
|
### Companion files
|
2018-01-07 20:13:42 +01:00
|
|
|
Some formats have companion files with external looping info, and should be
|
|
|
|
left together.
|
|
|
|
- .mus (playlist for .acm)
|
2018-10-20 14:54:49 +02:00
|
|
|
- .pos (loop info for .wav, and sometimes .ogg)
|
|
|
|
- .ogg.sli or .sli (loop info for .ogg)
|
|
|
|
- .ogg.sfl (loop info for .ogg)
|
|
|
|
- .vgmstream.pos (loop info for FFmpeg formats)
|
|
|
|
- also possible for certain extensions like .lflac.pos
|
|
|
|
|
|
|
|
Similarly some formats split header and/or data in separate files (.sgh+sgd,
|
|
|
|
.wav.str+.wav, (file)_L.dsp+(file)_R.dsp, etc). vgmstream will also detect
|
2019-08-11 19:38:40 +02:00
|
|
|
and use those as needed and must be together, even if only one of the two
|
2018-10-20 14:54:49 +02:00
|
|
|
will be used to play.
|
|
|
|
|
|
|
|
.pos is a small file with 32 bit little endian values: loop start sample
|
|
|
|
and loop end sample. For FFmpeg formats (.vgmstream.pos) it may optionally
|
|
|
|
have total samples after those.
|
2018-01-07 20:13:42 +01:00
|
|
|
|
|
|
|
### Decryption keys
|
|
|
|
Certain formats have encrypted data, and need a key to decrypt. vgmstream
|
|
|
|
will try to find the correct key from a list, but it can be provided by
|
|
|
|
a companion file:
|
2019-11-28 23:22:55 +01:00
|
|
|
- .adx: .adxkey (keystring, 8 byte keycode, or derived 6 byte start/mult/add key)
|
2019-08-25 20:16:06 +02:00
|
|
|
- .ahx: .ahxkey (derived 6 byte start/mult/add key)
|
2018-01-07 20:13:42 +01:00
|
|
|
- .hca: .hcakey (8 byte decryption key, a 64-bit number)
|
2018-10-20 14:54:49 +02:00
|
|
|
- May be followed by 2 byte AWB scramble key for newer HCA
|
2018-01-21 01:47:17 +01:00
|
|
|
- .fsb: .fsbkey (decryption key, in hex)
|
2018-01-07 20:13:42 +01:00
|
|
|
|
|
|
|
The key file can be ".(ext)key" (for the whole folder), or "(name).(ext)key"
|
|
|
|
(for a single file). The format is made up to suit vgmstream.
|
|
|
|
|
2019-10-06 23:31:32 +02:00
|
|
|
### Artificial files
|
2018-01-07 20:13:42 +01:00
|
|
|
In some cases a file only has raw data, while important header info (codec type,
|
|
|
|
sample rate, channels, etc) is stored in the .exe or other hard to locate places.
|
|
|
|
|
|
|
|
Those can be played using an artificial header with info vgmstream needs.
|
|
|
|
|
|
|
|
**GENH**: a byte header placed right before the original data, modyfing it.
|
|
|
|
The resulting file must be (name).genh. Contains static header data.
|
|
|
|
Programs like VGMToolbox can help to create GENH.
|
|
|
|
|
|
|
|
**TXTH**: a text header placed in an external file. The TXTH must be named
|
2019-10-06 23:31:32 +02:00
|
|
|
`.txth` or `.(ext).txth` (for the whole folder), or `(name.ext).txth` (for a
|
2018-01-07 20:13:42 +01:00
|
|
|
single file). Contains dynamic text commands to read data from the original
|
2019-10-06 23:31:32 +02:00
|
|
|
file, or static values.
|
|
|
|
|
|
|
|
*TXTH* is recomended over *GENH* as it's far easier to create and has many
|
|
|
|
more functions.
|
|
|
|
|
2018-10-20 14:54:49 +02:00
|
|
|
|
2019-10-06 23:31:32 +02:00
|
|
|
For files that already play, sometimes they are used by the game in various
|
|
|
|
complex and non-standard ways, like playing multiple small songs as a single
|
|
|
|
one, or using some channels as a section of the song. For those cases we
|
|
|
|
can use create a *TXTP* file.
|
|
|
|
|
|
|
|
**TXTP**: a text player configurator named `(name).txtp`. Text inside can
|
|
|
|
contain a list of filenames to play as one (ex. `intro.vag(line)loop.vag`),
|
|
|
|
list of separate channel files to join as a single multichannel file,
|
|
|
|
subsong index (ex. `bgm.sxd#10`), per-file configurations like number of
|
|
|
|
loops, remove unneeded channels, and many other features.
|
2018-01-07 20:13:42 +01:00
|
|
|
|
2018-10-20 14:54:49 +02:00
|
|
|
Creation of those files is meant for advanced users, docs can be found in
|
|
|
|
vgmstream source.
|
|
|
|
|
2019-10-06 23:31:32 +02:00
|
|
|
|
2019-01-27 23:40:50 +01:00
|
|
|
### Plugin conflicts
|
|
|
|
Since vgmstream supports a huge amount of formats it's possibly that some of
|
|
|
|
them are also supported in other plugins, and this sometimes causes conflicts.
|
|
|
|
If a file that should isn't playing or looping, first make sure vgmstream is
|
2019-03-04 00:06:05 +01:00
|
|
|
really opening it (should show "VGMSTREAM" somewhere in the file info), and
|
|
|
|
try to remove a few other plugins.
|
|
|
|
|
2019-10-06 23:31:32 +02:00
|
|
|
foobar's FFmpeg plugin and foo_adpcm are known to cause issues, but in
|
2019-03-04 00:06:05 +01:00
|
|
|
recent versions (1.4.x) you can configure plugin priority.
|
2019-01-27 23:40:50 +01:00
|
|
|
|
2019-10-06 23:31:32 +02:00
|
|
|
In Audacious, vgmstream is set with slightly higher priority than FFmpeg,
|
|
|
|
since it steals many formats that you normally want to loop (like .adx).
|
|
|
|
However other plugins may set themselves higher, stealing formats instead.
|
|
|
|
If current Audacious version doesn't let to change plugin priority you may
|
|
|
|
need to disable some plugins (requires restart) or set priority on compile
|
|
|
|
time. Particularly, mpg123 plugin may steal formats that aren't even MP3,
|
|
|
|
making impossible for vgmstream to play it properly.
|
|
|
|
|
|
|
|
|
2019-02-10 18:43:24 +01:00
|
|
|
### Channel issues
|
|
|
|
Some games layer a huge number of channels, that are disabled or downmixed
|
|
|
|
during gameplay. The player may be unable to play those files (for example
|
2019-09-02 20:48:33 +02:00
|
|
|
foobar can only play up to 8 channels, and Winamp depends on your sound
|
2019-02-10 18:43:24 +01:00
|
|
|
card). For those files you can set the "downmix" option in vgmstream, that
|
2019-03-04 00:06:05 +01:00
|
|
|
can reduce the number of channels to a playable amount. Note that this type
|
|
|
|
of downmixing is very generic, not meant to be used when converting to other
|
|
|
|
formats.
|
2018-01-07 20:13:42 +01:00
|
|
|
|
2018-11-04 00:11:02 +01:00
|
|
|
## Tagging
|
|
|
|
Some of vgmstream's plugins support simple read-only tagging via external files.
|
|
|
|
|
2019-06-15 13:21:23 +02:00
|
|
|
Tags are loaded from a text/M3U-like file named *!tags.m3u* in the song folder.
|
2018-11-04 00:11:02 +01:00
|
|
|
You don't have to load your songs with that M3U though (but you can, for pre-made
|
|
|
|
ordering), the file itself just 'looks' like an M3U.
|
|
|
|
|
|
|
|
Format is:
|
|
|
|
```
|
|
|
|
# ignored comment
|
2019-11-28 23:22:55 +01:00
|
|
|
# $GLOBAL_COMMAND (extra features)
|
|
|
|
# @GLOBAL_TAG text (applies all following tracks)
|
2018-11-04 00:11:02 +01:00
|
|
|
|
2019-11-28 23:22:55 +01:00
|
|
|
# %LOCAL_TAG text (applies to next track only)
|
2018-11-04 00:11:02 +01:00
|
|
|
filename1
|
2019-11-28 23:22:55 +01:00
|
|
|
# %LOCAL_TAG text (applies to next track only)
|
2018-11-04 00:11:02 +01:00
|
|
|
filename2
|
|
|
|
```
|
|
|
|
Accepted tags depend on the player (foobar: any; winamp: see ATF config),
|
2019-10-06 23:31:32 +02:00
|
|
|
typically *ALBUM/ARTIST/TITLE/DISC/TRACK/COMPOSER/etc*, lower or uppercase,
|
2018-11-04 00:11:02 +01:00
|
|
|
separated by one or multiple spaces. Repeated tags overwrite previous
|
2019-10-06 23:31:32 +02:00
|
|
|
(ex.- may define *@COMPOSER* for multiple tracks). It only reads up to current
|
|
|
|
*filename* though, so any *@TAG* below would be ignored.
|
2018-11-04 00:11:02 +01:00
|
|
|
|
|
|
|
Playlist formatting should follow player's config. ASCII or UTF-8 tags work.
|
|
|
|
|
2019-10-06 23:31:32 +02:00
|
|
|
*GLOBAL_COMMAND*s currently can be:
|
|
|
|
- *AUTOTRACK*: sets *%TRACK* tag automatically (1..N as files are encountered
|
2018-11-17 17:54:42 +01:00
|
|
|
in the tag file).
|
2019-10-06 23:31:32 +02:00
|
|
|
- *AUTOALBUM*: sets *%ALBUM* tag automatically using the containing dir as album.
|
2018-11-17 17:54:42 +01:00
|
|
|
|
2019-11-28 23:22:55 +01:00
|
|
|
Some players like foobar accept tags with spaces. To use them surround the tag
|
|
|
|
with both characters.
|
|
|
|
```
|
|
|
|
# @GLOBAL TAG WITH SPACES@ text
|
|
|
|
# ...
|
|
|
|
# %LOCAL TAG WITH SPACES% text
|
|
|
|
filename1
|
|
|
|
```
|
|
|
|
As a side effect if text has @/% inside you also need them: `# @ALBUMARTIST@ Tom-H@ck`
|
|
|
|
|
2019-06-15 13:21:23 +02:00
|
|
|
Note that since you can use global tags don't need to put all files inside.
|
|
|
|
This would be a perfectly valid *!tags.m3u*:
|
|
|
|
```
|
|
|
|
# @ALBUM Game
|
|
|
|
# @ARTIST Various Artists
|
|
|
|
```
|
|
|
|
|
|
|
|
foobar2000/Winamp can apply the following replaygain tags (if ReplayGain is
|
|
|
|
enabled in preferences):
|
2019-03-04 00:06:05 +01:00
|
|
|
```
|
|
|
|
# %replaygain_track_gain N.NN dB
|
|
|
|
# %replaygain_track_peak N.NNN
|
2019-03-04 23:19:05 +01:00
|
|
|
# @replaygain_album_gain N.NN dB
|
|
|
|
# @replaygain_album_peak N.NNN
|
2019-03-04 00:06:05 +01:00
|
|
|
```
|
|
|
|
|
|
|
|
If your player isn't picking tags make sure vgmstream is detecting the song
|
|
|
|
(as other plugins can steal its extensions, see above), .m3u is properly
|
2019-03-30 02:22:20 +01:00
|
|
|
named and that filenames inside match the song filename. For Winamp you need
|
2019-10-06 23:31:32 +02:00
|
|
|
to make sure *options > titles > advanced title formatting* checkbox is set and
|
2019-03-30 02:22:20 +01:00
|
|
|
the format defined.
|
2019-03-04 00:06:05 +01:00
|
|
|
|
2019-09-15 15:47:41 +02:00
|
|
|
## Virtual TXTP files
|
|
|
|
Some of vgmstream's plugins allow you to use virtual .txtp files, that combined
|
|
|
|
with playlists let you make quick song configs.
|
|
|
|
|
|
|
|
Normally you can create a physical .txtp file that points to another file with
|
|
|
|
config, and .txtp have a "mini-txtp" mode that configures files with only the
|
|
|
|
filename.
|
|
|
|
|
|
|
|
Instead of manually creating .txtp files you can put non-existing virtual .txtp
|
|
|
|
in a `.m3u` playlist:
|
|
|
|
```
|
|
|
|
# playlist that opens subsongs directly without having to create .txtp
|
|
|
|
# notice the full filename, then #(config), then ".txtp" (spaces are optional)
|
|
|
|
bank_bgm_full.nub #s1 .txtp
|
|
|
|
bank_bgm_full.nub #s10 .txtp
|
|
|
|
```
|
|
|
|
|
|
|
|
Combine with tagging (see above) for extra fun OST-like config.
|
|
|
|
```
|
|
|
|
# @ALBUM GOD HAND
|
|
|
|
|
|
|
|
# play 1 loop, delay and do a longer fade
|
|
|
|
# %TITLE Too Hot !!
|
|
|
|
circus_a_mix_ver2.adx #l 1.0 #d 5.0 #f 15.0 .txtp
|
|
|
|
|
|
|
|
# play 1 loop instead of the default 2 then fade with the song's internal fading
|
|
|
|
# %TITLE Yet... Oh see mind
|
|
|
|
boss2_3ningumi_ver6.adx #l 1.0 #F .txtp
|
|
|
|
|
|
|
|
...
|
|
|
|
```
|
|
|
|
|
|
|
|
You can also use it in CLI for quick access to some txtp-exclusive functions:
|
|
|
|
```
|
|
|
|
# force change sample rate to 22050
|
|
|
|
test.exe btl_koopa1_44k_lp.brstm #h22050.txtp -o btl_koopa1_44k_lp.wav
|
|
|
|
```
|
|
|
|
|
2018-11-04 00:11:02 +01:00
|
|
|
|
2017-11-24 21:01:28 +01:00
|
|
|
## Supported codec types
|
2019-08-11 19:38:40 +02:00
|
|
|
Quick list of codecs vgmstream supports, including many obscure ones that
|
2017-11-24 21:01:28 +01:00
|
|
|
are used in few games.
|
|
|
|
|
|
|
|
- PCM 16-bit
|
|
|
|
- PCM 8-bit (signed/unsigned)
|
2019-03-04 23:19:05 +01:00
|
|
|
- PCM 4-bit (signed/unsigned)
|
2017-11-24 21:01:28 +01:00
|
|
|
- PCM 32-bit float
|
|
|
|
- u-Law/a-LAW
|
|
|
|
- CRI ADX (standard, fixed, exponential, encrypted)
|
|
|
|
- Nintendo DSP ADPCM a.k.a GC ADPCM
|
|
|
|
- Nintendo DTK ADPCM
|
|
|
|
- Nintendo AFC ADPCM
|
|
|
|
- ITU-T G.721
|
|
|
|
- CD-ROM XA ADPCM
|
2019-08-11 19:38:40 +02:00
|
|
|
- Sony PSX ADPCM a.k.a VAG (standard, badflags, configurable, Pivotal)
|
2017-11-24 21:01:28 +01:00
|
|
|
- Sony HEVAG
|
|
|
|
- Electronic Arts EA-XA (stereo, mono, Maxis)
|
2019-01-27 23:40:50 +01:00
|
|
|
- Electronic Arts EA-XAS (v0, v1)
|
2017-11-24 21:01:28 +01:00
|
|
|
- DVI/IMA ADPCM (stereo/mono + high/low nibble, 3DS, Omikron, SNDS, etc)
|
2018-08-12 22:59:38 +02:00
|
|
|
- Microsoft MS IMA ADPCM (standard, Xbox, NDS, Radical, Wwise, FSB, WV6, etc)
|
|
|
|
- Microsoft MS ADPCM (standard, Cricket Audio)
|
|
|
|
- Westwood VBR ADPCM
|
2019-09-21 19:15:01 +02:00
|
|
|
- Yamaha ADPCM (AICA, Aska)
|
2018-08-12 22:59:38 +02:00
|
|
|
- Procyon Studio ADPCM
|
2017-11-24 21:01:28 +01:00
|
|
|
- Level-5 0x555 ADPCM
|
|
|
|
- lsf ADPCM
|
|
|
|
- Konami MTAF ADPCM
|
|
|
|
- Konami MTA2 ADPCM
|
|
|
|
- Paradigm MC3 ADPCM
|
2018-09-06 17:45:34 +02:00
|
|
|
- FMOD FADPCM 4-bit ADPCM
|
|
|
|
- Konami XMD 4-bit ADPCM
|
2019-08-29 00:54:49 +02:00
|
|
|
- Platinum 4-bit ADPCM
|
2018-09-06 17:45:34 +02:00
|
|
|
- Argonaut ASF 4-bit ADPCM
|
2019-02-10 18:43:24 +01:00
|
|
|
- Ocean DSA 4-bit ADPCM
|
2018-11-17 17:54:42 +01:00
|
|
|
- Circus XPCM ADPCM
|
2019-09-08 21:16:04 +02:00
|
|
|
- OKI 4-bit ADPCM (16-bit output, 4-shift, PC-FX)
|
|
|
|
- Ubisoft 4/6-bit ADPCM
|
2017-11-24 21:01:28 +01:00
|
|
|
- SDX2 2:1 Squareroot-Delta-Exact compression DPCM
|
|
|
|
- CBD2 2:1 Cuberoot-Delta-Exact compression DPCM
|
2018-09-06 17:45:34 +02:00
|
|
|
- Activision EXAKT SASSC DPCM
|
|
|
|
- Xilam DERF DPCM
|
2017-11-24 21:01:28 +01:00
|
|
|
- InterPlay ACM
|
2018-03-17 19:57:54 +01:00
|
|
|
- VisualArt's NWA
|
2017-12-03 17:27:27 +01:00
|
|
|
- Electronic Arts MicroTalk a.k.a. UTK or UMT
|
2018-09-06 17:45:34 +02:00
|
|
|
- CRI HCA
|
2017-11-24 21:01:28 +01:00
|
|
|
- Xiph Vorbis (Ogg, FSB5, Wwise, OGL, Silicon Knights)
|
|
|
|
- MPEG MP1/2/3 (standard, AHX, XVAG, FSB, AWC, P3D, etc)
|
|
|
|
- ITU-T G.722.1 annex C (Polycom Siren 14)
|
|
|
|
- ITU G.719 annex B (Polycom Siren 22)
|
2017-12-24 01:30:57 +01:00
|
|
|
- Electronic Arts EALayer3
|
|
|
|
- Electronic Arts EA-XMA
|
|
|
|
- Sony ATRAC3, ATRAC3plus
|
2018-01-05 00:57:00 +01:00
|
|
|
- Sony ATRAC9
|
2017-12-24 01:30:57 +01:00
|
|
|
- Microsoft XMA1/2
|
|
|
|
- Microsoft WMA v1, WMA v2, WMAPro
|
|
|
|
- AAC
|
|
|
|
- Bink
|
|
|
|
- AC3/SPDIF
|
2018-10-20 14:54:49 +02:00
|
|
|
- Xiph Opus (Ogg, Switch, EA, UE4, Exient)
|
2018-08-12 22:59:38 +02:00
|
|
|
- Xiph CELT (FSB)
|
2017-12-28 22:30:45 +01:00
|
|
|
- Musepack
|
2017-12-24 01:30:57 +01:00
|
|
|
- FLAC
|
|
|
|
- Others
|
|
|
|
|
|
|
|
Note that vgmstream doesn't (can't) reproduce in-game music 1:1, as internal
|
|
|
|
resampling, filters, volume, etc, are not replicated. Some codecs are not
|
|
|
|
fully accurate compared to the games due to minor bugs, but in most cases
|
2018-10-20 14:54:49 +02:00
|
|
|
it isn't audible.
|
2017-11-24 22:43:33 +01:00
|
|
|
|
2017-10-09 04:08:04 +02:00
|
|
|
|
2017-11-24 21:01:28 +01:00
|
|
|
## Supported file types
|
2017-10-09 04:08:04 +02:00
|
|
|
As manakoAT likes to say, the extension doesn't really mean anything, but it's
|
|
|
|
the most obvious way to identify files.
|
|
|
|
|
|
|
|
This list is not complete and many other files are supported.
|
|
|
|
|
|
|
|
- PS2/PSX ADPCM:
|
|
|
|
- .ads/.ss2
|
|
|
|
- .ass
|
|
|
|
- .ast
|
|
|
|
- .bg00
|
|
|
|
- .bmdx
|
|
|
|
- .ccc
|
|
|
|
- .cnk
|
|
|
|
- .dxh
|
|
|
|
- .enth
|
|
|
|
- .fag
|
|
|
|
- .filp
|
|
|
|
- .gcm
|
|
|
|
- .gms
|
|
|
|
- .hgc1
|
|
|
|
- .ikm
|
|
|
|
- .ild
|
|
|
|
- .ivb
|
|
|
|
- .joe
|
|
|
|
- .kces
|
|
|
|
- .khv
|
|
|
|
- .leg
|
|
|
|
- .mcg
|
|
|
|
- .mib, .mi4 (w/ or w/o .mih)
|
|
|
|
- .mic
|
|
|
|
- .mihb (merged mih+mib)
|
|
|
|
- .msa
|
|
|
|
- .msvp
|
|
|
|
- .musc
|
|
|
|
- .npsf
|
|
|
|
- .pnb
|
|
|
|
- .psh
|
|
|
|
- .rkv
|
|
|
|
- .rnd
|
|
|
|
- .rstm
|
|
|
|
- .rws
|
|
|
|
- .rxw
|
|
|
|
- .snd
|
|
|
|
- .sfs
|
|
|
|
- .sl3
|
|
|
|
- .smpl (w/ bad flags)
|
|
|
|
- .ster
|
|
|
|
- .str+.sth
|
|
|
|
- .str (MGAV blocked)
|
|
|
|
- .sts
|
|
|
|
- .svag
|
|
|
|
- .svs
|
|
|
|
- .tec (w/ bad flags)
|
|
|
|
- .tk5 (w/ bad flags)
|
|
|
|
- .vas
|
|
|
|
- .vag
|
|
|
|
- .vgs (w/ bad flags)
|
|
|
|
- .vig
|
|
|
|
- .vpk
|
|
|
|
- .vs
|
|
|
|
- .vsf
|
|
|
|
- .wp2
|
|
|
|
- .xa2
|
|
|
|
- .xa30
|
|
|
|
- .xwb+xwh
|
|
|
|
- GC/Wii/3DS DSP ADPCM:
|
|
|
|
- .aaap
|
|
|
|
- .agsc
|
|
|
|
- .asr
|
|
|
|
- .bns
|
|
|
|
- .bo2
|
|
|
|
- .capdsp
|
|
|
|
- .cfn
|
|
|
|
- .ddsp
|
|
|
|
- .dsp
|
|
|
|
- standard, optional dual file stereo
|
|
|
|
- RS03
|
|
|
|
- Cstr
|
|
|
|
- _lr.dsp
|
|
|
|
- MPDS
|
|
|
|
- .gca
|
|
|
|
- .gcm
|
|
|
|
- .gsp+.gsp
|
|
|
|
- .hps
|
|
|
|
- .idsp
|
|
|
|
- .ish+.isd
|
|
|
|
- .lps
|
|
|
|
- .mca
|
|
|
|
- .mpdsp
|
|
|
|
- .mss
|
|
|
|
- .mus (not quite right)
|
|
|
|
- .ndp
|
|
|
|
- .pdt
|
|
|
|
- .sdt
|
|
|
|
- .smp
|
|
|
|
- .sns
|
|
|
|
- .spt+.spd
|
|
|
|
- .ssm
|
|
|
|
- .stm/.dsp
|
|
|
|
- .str
|
|
|
|
- .str+.sth
|
|
|
|
- .sts
|
|
|
|
- .swd
|
|
|
|
- .thp, .dsp
|
|
|
|
- .tydsp
|
|
|
|
- .vjdsp
|
|
|
|
- .waa, .wac, .wad, .wam
|
|
|
|
- .was
|
|
|
|
- .wsd
|
|
|
|
- .wsi
|
|
|
|
- .ydsp
|
|
|
|
- .ymf
|
|
|
|
- .zwdsp
|
|
|
|
- PCM:
|
|
|
|
- .aiff (8 bit, 16 bit)
|
|
|
|
- .asd (16 bit)
|
|
|
|
- .baka (16 bit)
|
|
|
|
- .bh2pcm (16 bit)
|
|
|
|
- .dmsg (16 bit)
|
|
|
|
- .gcsw (16 bit)
|
|
|
|
- .gcw (16 bit)
|
|
|
|
- .his (8 bit)
|
|
|
|
- .int (16 bit)
|
|
|
|
- .pcm (8 bit, 16 bit)
|
|
|
|
- .kraw (16 bit)
|
|
|
|
- .raw (16 bit)
|
|
|
|
- .rwx (16 bit)
|
|
|
|
- .sap (16 bit)
|
|
|
|
- .snd (16 bit)
|
|
|
|
- .sps (16 bit)
|
|
|
|
- .str (16 bit)
|
|
|
|
- .xss (16 bit)
|
|
|
|
- .voi (16 bit)
|
|
|
|
- .wb (16 bit)
|
|
|
|
- .zsd (8 bit)
|
|
|
|
- Xbox IMA ADPCM:
|
|
|
|
- .matx
|
|
|
|
- .wavm
|
|
|
|
- .wvs
|
|
|
|
- .xmu
|
|
|
|
- .xvas
|
|
|
|
- .xwav
|
2019-09-21 19:15:01 +02:00
|
|
|
- Yamaha AICA ADPCM:
|
2017-10-09 04:08:04 +02:00
|
|
|
- .adpcm
|
|
|
|
- .dcs+.dcsw
|
|
|
|
- .str
|
|
|
|
- .spsd
|
|
|
|
- IMA ADPCM:
|
|
|
|
- .bar (IMA ADPCM)
|
2017-11-18 02:20:52 +01:00
|
|
|
- .pcm/dvi (DVI IMA ADPCM)
|
2017-10-09 04:08:04 +02:00
|
|
|
- .hwas (IMA ADPCM)
|
2017-11-18 02:20:52 +01:00
|
|
|
- .dvi/idvi (DVI IMA ADPCM)
|
2017-10-09 04:08:04 +02:00
|
|
|
- .ivaud (IMA ADPCM)
|
|
|
|
- .myspd (IMA ADPCM)
|
|
|
|
- .strm (IMA ADPCM)
|
|
|
|
- multi:
|
|
|
|
- .aifc (SDX2 DPCM, DVI IMA ADPCM)
|
2017-11-18 02:20:52 +01:00
|
|
|
- .asf/as4 (8/16 bit PCM, DVI IMA ADPCM)
|
2017-10-09 04:08:04 +02:00
|
|
|
- .ast (GC AFC ADPCM, 16 bit PCM)
|
|
|
|
- .aud (IMA ADPCM, WS DPCM)
|
|
|
|
- .aus (PSX ADPCM, Xbox IMA ADPCM)
|
|
|
|
- .brstm (GC DSP ADPCM, 8/16 bit PCM)
|
|
|
|
- .emff (PSX APDCM, GC DSP ADPCM)
|
|
|
|
- .fsb/wii (PSX ADPCM, GC DSP ADPCM, Xbox IMA ADPCM, MPEG audio, FSB Vorbis, MS XMA)
|
|
|
|
- .msf (PCM, PSX ADPCM, ATRAC3, MP3)
|
|
|
|
- .musx (PSX ADPCM, Xbox IMA ADPCM, DAT4 IMA ADPCM)
|
|
|
|
- .nwa (16 bit PCM, NWA DPCM)
|
|
|
|
- .p3d (Radical ADPCM, Radical MP3, XMA2)
|
|
|
|
- .psw (PSX ADPCM, GC DSP ADPCM)
|
|
|
|
- .rwar, .rwav (GC DSP ADPCM, 8/16 bit PCM)
|
|
|
|
- .rws (PSX ADPCM, XBOX IMA ADPCM, GC DSP ADPCM, 16 bit PCM)
|
|
|
|
- .rwsd (GC DSP ADPCM, 8/16 bit PCM)
|
|
|
|
- .rsd (PSX ADPCM, 16 bit PCM, GC DSP ADPCM, Xbox IMA ADPCM, Radical ADPCM)
|
|
|
|
- .rrds (NDS IMA ADPCM)
|
|
|
|
- .sad (GC DSP ADPCM, NDS IMA ADPCM, Procyon Studios NDS ADPCM)
|
|
|
|
- .sgd/sgb+sgh/sgx (PSX ADPCM, ATRAC3plus, AC3)
|
|
|
|
- .seg (Xbox IMA ADPCM, PS2 ADPCM)
|
|
|
|
- .sng/asf/str/eam/aud (8/16 bit PCM, EA-XA ADPCM, PSX ADPCM, GC DSP ADPCM, XBOX IMA ADPCM, MPEG audio, EALayer3)
|
|
|
|
- .strm (NDS IMA ADPCM, 8/16 bit PCM)
|
2017-11-18 02:20:52 +01:00
|
|
|
- .sb0..7 (Ubi IMA ADPCM, GC DSP ADPCM, PSX ADPCM, Xbox IMA ADPCM, ATRAC3)
|
2017-10-09 04:08:04 +02:00
|
|
|
- .swav (NDS IMA ADPCM, 8/16 bit PCM)
|
|
|
|
- .xwb (PCM, Xbox IMA ADPCM, MS ADPCM, XMA, XWMA, ATRAC3)
|
|
|
|
- .xwb+xwh (PCM, PSX ADPCM, ATRAC3)
|
|
|
|
- .wav/lwav (unsigned 8 bit PCM, 16 bit PCM, GC DSP ADPCM, MS IMA ADPCM, XBOX IMA ADPCM)
|
|
|
|
- .wem [lwav/logg/xma] (PCM, Wwise Vorbis, Wwise IMA ADPCM, XMA, XWMA, GC DSP ADPCM, Wwise Opus)
|
|
|
|
- etc:
|
|
|
|
- .2dx9 (MS ADPCM)
|
|
|
|
- .aax (CRI ADX ADPCM)
|
|
|
|
- .acm (InterPlay ACM)
|
|
|
|
- .adp (GC DTK ADPCM)
|
|
|
|
- .adx (CRI ADX ADPCM)
|
|
|
|
- .afc (GC AFC ADPCM)
|
|
|
|
- .ahx (MPEG-2 Layer II)
|
|
|
|
- .aix (CRI ADX ADPCM)
|
|
|
|
- .at3 (Sony ATRAC3 / ATRAC3plus)
|
|
|
|
- .aud (Silicon Knights Vorbis)
|
|
|
|
- .baf (PSX configurable ADPCM)
|
|
|
|
- .bgw (PSX configurable ADPCM)
|
|
|
|
- .bnsf (G.722.1)
|
|
|
|
- .caf (Apple IMA4 ADPCM, others)
|
2017-11-23 22:48:11 +01:00
|
|
|
- .dec/de2 (MS ADPCM)
|
2017-10-09 04:08:04 +02:00
|
|
|
- .hca (CRI High Compression Audio)
|
2017-11-18 02:20:52 +01:00
|
|
|
- .pcm/kcey (DVI IMA ADPCM)
|
2017-10-09 04:08:04 +02:00
|
|
|
- .lsf (LSF ADPCM)
|
|
|
|
- .mc3 (Paradigm MC3 ADPCM)
|
|
|
|
- .mp4/lmp4 (AAC)
|
|
|
|
- .msf (PCM, PSX ADPCM, ATRAC3, MP3)
|
|
|
|
- .mtaf (Konami ADPCM)
|
|
|
|
- .mta2 (Konami XAS-like ADPCM)
|
|
|
|
- .mwv (Level-5 0x555 ADPCM)
|
|
|
|
- .ogg/logg (Ogg Vorbis)
|
|
|
|
- .ogl (Shin'en Vorbis)
|
|
|
|
- .rsf (CCITT G.721 ADPCM)
|
|
|
|
- .sab (Worms 4 soundpacks)
|
|
|
|
- .s14/sss (G.722.1)
|
|
|
|
- .sc (Activision EXAKT SASSC DPCM)
|
|
|
|
- .scd (MS ADPCM, MPEG Audio, 16 bit PCM)
|
|
|
|
- .sd9 (MS ADPCM)
|
|
|
|
- .smp (MS ADPCM)
|
|
|
|
- .spw (PSX configurable ADPCM)
|
|
|
|
- .stm/lstm [amts/ps2stm/stma] (16 bit PCM, DVI IMA ADPCM, GC DSP ADPCM)
|
|
|
|
- .str (SDX2 DPCM)
|
|
|
|
- .stx (GC AFC ADPCM)
|
|
|
|
- .ulw (u-Law PCM)
|
|
|
|
- .um3 (Ogg Vorbis)
|
|
|
|
- .xa (CD-ROM XA audio)
|
|
|
|
- .xma (MS XMA/XMA2)
|
2019-01-27 23:40:50 +01:00
|
|
|
- .sb0/sb1/sb2/sb3/sb4/sb5/sb6/sb7 (many)
|
|
|
|
- .sm0/sm1/sm2/sm3/sm4/sm5/sm6/sm7 (many)
|
2019-03-04 00:06:05 +01:00
|
|
|
- .bao/pk (many)
|
2017-12-24 01:30:57 +01:00
|
|
|
- artificial/generic headers:
|
|
|
|
- .genh (lots)
|
|
|
|
- .txth (lots)
|
2017-10-09 04:08:04 +02:00
|
|
|
- loop assists:
|
|
|
|
- .mus (playlist for .acm)
|
|
|
|
- .pos (loop info for .wav: 32 bit LE loop start sample + loop end sample)
|
|
|
|
- .sli (loop info for .ogg)
|
|
|
|
- .sfl (loop info for .ogg)
|
2019-03-04 00:06:05 +01:00
|
|
|
- .vgmstream + .vgmstream.pos (FFmpeg formats + loop assist)
|
2017-10-09 04:08:04 +02:00
|
|
|
- other:
|
|
|
|
- .adxkey (decryption key for .adx, in start/mult/add format)
|
|
|
|
- .ahxkey (decryption key for .ahx, in start/mult/add format)
|
2018-01-21 01:47:17 +01:00
|
|
|
- .hcakey (decryption key for .hca, in HCA Decoder format)
|
|
|
|
- .fsbkey (decryption key for .fsb, in hex)
|
2019-03-04 00:06:05 +01:00
|
|
|
- .txtp (per song segment/layer handler and player configurator)
|
2017-10-09 04:08:04 +02:00
|
|
|
|
|
|
|
Enjoy! *hcs*
|