Mercurial > audlegacy-plugins

comparison src/console/readme.txt @ 341:986f098da058 trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[svn] - merge in blargg's changes
author nenolod
date Thu, 07 Dec 2006 15:20:41 -0800
parents fb513e10174e
children
comparison
equal deleted inserted replaced
340:9e5a7158fa80 341:986f098da058
2 ----------------------------------------- 2 -----------------------------------------
3 This plugin plays music from video game consoles of the 1980s and early 3 This plugin plays music from video game consoles of the 1980s and early
4 1990s. It uses the Game_Music_Emu sound engine and supports the 4 1990s. It uses the Game_Music_Emu sound engine and supports the
5 following file formats: 5 following file formats:
6 6
7 AY Sinclair Spectrum 7 AY ZX Spectrum/Amstrad CPC
8 GBS Nintendo Game Boy 8 GBS Nintendo Game Boy
9 GYM Sega Genesis/Mega Drive 9 GYM Sega Genesis/Mega Drive
10 HES NEC TurboGrafx-16/PC Engine 10 HES NEC TurboGrafx-16/PC Engine
11 KSS MSX Home Computer/other Z80 systems (doesn't support FM sound) 11 KSS MSX Home Computer/other Z80 systems (doesn't support FM sound)
12 NSF/NSFE Nintendo NES/Famicom (with VRC 6, Namco 106, and FME-7 sound) 12 NSF/NSFE Nintendo NES/Famicom (with VRC 6, Namco 106, and FME-7 sound)
41 unfortunately. 41 unfortunately.
42 42
43 43
44 Things not supported 44 Things not supported
45 -------------------- 45 --------------------
46 * Gzipped files (Audacious needs to support these in its VFS layer)
47
48 * KSS: FM sound 46 * KSS: FM sound
49
50 * GYM: files without a header
51 47
52 * HES: ADPCM samples (used in only a few soundtracks, if that) 48 * HES: ADPCM samples (used in only a few soundtracks, if that)
53 49
54 * SAP: "digimusic samples" and more obscure tracker formats 50 * SAP: "digimusic samples" and more obscure tracker formats
55 51
56 * VGM/VGZ: original Sega Master System FM sound chip (Sega Genesis/Mega 52 * VGM/VGZ: original Sega Master System FM sound chip (Sega Genesis/Mega
57 Drive music plays fine) 53 Drive music plays fine). See the following discussion for a way to add
54 support for this: http://www.smspower.org/forums/viewtopic.php?t=9321
58 55
59 56
60 Source code notes 57 Source code notes
61 ----------------- 58 -----------------
62 Game_Music_Emu library configuration is in blargg_config.h. See 59 Game_Music_Emu library configuration is in blargg_config.h. See
63 gme_readme.txt and gme.txt for library documentation. 60 gme_readme.txt and gme.txt for library documentation.
64 61
65 * See TODO comments in Audacious_Config.cxx and Audacious_Driver.cxx for 62 * See TODO comments in Audacious_Config.cxx and Audacious_Driver.cxx for
66 things which would be good to address. 63 things which would be good to address.
67 64
68 * The library does not use C++ exceptions, so you could disable them in 65 * C++ exceptions and RTTI are not used or needed.
69 the makefile to reduce code size a bit.
70 66
71 * The cause of errors and also warnings about possible problems are 67 * File types are determined based on the first four bytes of a file
72 logged in log_err() and log_warning() using printf(). 68 except for .gym files, some of which have no file header at all.
73
74 * The vfs_* functions are used for file access, so gzipped game music
75 files must currently be decompressed before playback (in particular,
76 .vgz files).
77
78 * File types are determined based on the first four bytes of a file; the
79 file extension is never examined. Some .gym files don't have any header,
80 so these won't play.
81 69
82 * Some music formats have more than one track in a file. This track is 70 * Some music formats have more than one track in a file. This track is
83 specified to the console plugin by appending ?i to the end of the file 71 specified to the console plugin by appending ?i to the end of the file
84 path, where i is the track index, starting at 0. For example, foo.nsf?2 72 path, where i is the track index, starting at 0. For example, foo.nsf?2
85 specifies the third track. 73 specifies the third track. This is an internal thing, as the user should
74 never see these modified paths.