/readme.txt

  1Game_Music_Emu 0.5.5: Game Music Emulators
  2------------------------------------------
  3Game_Music_Emu is a collection of video game music file emulators that
  4support the following formats and systems:
  5
  6AY        ZX Spectrum/Amstrad CPC
  7GBS       Nintendo Game Boy
  8GYM       Sega Genesis/Mega Drive
  9HES       NEC TurboGrafx-16/PC Engine
 10KSS       MSX Home Computer/other Z80 systems (doesn't support FM sound)
 11NSF/NSFE  Nintendo NES/Famicom (with VRC 6, Namco 106, and FME-7 sound)
 12SAP       Atari systems using POKEY sound chip
 13SPC       Super Nintendo/Super Famicom
 14VGM/VGZ   Sega Master System/Mark III, Sega Genesis/Mega Drive,BBC Micro
 15
 16Features:
 17* C interface for use in C, C++, and other compatible languages
 18* High emphasis has been placed on making the library very easy to use
 19* One set of common functions work with all emulators the same way
 20* Several code examples, including music player using SDL
 21* Portable code for use on any system with modern or older C++ compilers
 22* Adjustable output sample rate using quality band-limited resampling
 23* Uniform access to text information fields and track timing information
 24* End-of-track fading and automatic look ahead silence detection
 25* Treble/bass and stereo echo for AY/GBS/HES/KSS/NSF/NSFE/SAP/VGM
 26* Tempo can be adjusted and individual voices can be muted while playing
 27* Can read music data from file, memory, or custom reader function/class
 28* Can access track information without having to load into full emulator
 29* M3U track listing support for multi-track formats
 30* Modular design allows elimination of unneeded emulators/features
 31
 32This library has been used in game music players for Windows, Linux on
 33several architectures, Mac OS, MorphOS, Xbox, PlayStation Portable,
 34GP2X, and Nintendo DS.
 35
 36Author : Shay Green <gblargg@gmail.com>
 37Website: http://www.slack.net/~ant/
 38Forum  : http://groups.google.com/group/blargg-sound-libs
 39License: GNU Lesser General Public License (LGPL)
 40
 41
 42Getting Started
 43---------------
 44Build a program consisting of demo/basics.c, demo/Wave_Writer.cpp, and
 45all source files in gme/. If you have CMake 2.6 or later, execute
 46
 47	run cmake
 48	cd demo
 49	run make
 50
 51Be sure "test.nsf" is in the same directory as the program. Running it
 52should generate the recording "out.wav".
 53
 54A slightly more extensive demo application is available in the player/
 55directory.  It requires SDL to build.
 56
 57Read gme.txt for more information. Post to the discussion forum for
 58assistance.
 59
 60
 61Files
 62-----
 63gme.txt               General notes about the library
 64changes.txt           Changes made since previous releases
 65design.txt            Library design notes
 66license.txt           GNU Lesser General Public License
 67CMakeLists.txt        CMake build rules
 68
 69test.nsf              Test file for NSF emulator
 70test.m3u              Test m3u playlist for features.c demo
 71
 72demo/
 73  basics.c            Records NSF file to wave sound file
 74  features.c          Demonstrates many additional features
 75  Wave_Writer.h       WAVE sound file writer used for demo output
 76  Wave_Writer.cpp
 77  CMakeLists.txt      CMake build rules
 78
 79player/               Player using the SDL multimedia library
 80  player.cpp          Simple music player with waveform display
 81  Music_Player.cpp    Stand alone player for background music
 82  Music_Player.h
 83  Audio_Scope.cpp     Audio waveform scope
 84  Audio_Scope.h
 85  CMakeLists.txt      CMake build rules
 86
 87gme/
 88  blargg_config.h     Library configuration (modify this file as needed)
 89
 90  gme.h               Library interface header file
 91  gme.cpp
 92
 93  Ay_Emu.h            ZX Spectrum AY emulator
 94  Ay_Emu.cpp
 95  Ay_Apu.cpp
 96  Ay_Apu.h
 97  Ay_Cpu.cpp
 98  Ay_Cpu.h
 99
100  Gbs_Emu.h           Nintendo Game Boy GBS emulator
101  Gbs_Emu.cpp
102  Gb_Apu.cpp
103  Gb_Apu.h
104  Gb_Cpu.cpp
105  Gb_Cpu.h
106  gb_cpu_io.h
107  Gb_Oscs.cpp
108  Gb_Oscs.h
109
110  Hes_Emu.h           TurboGrafx-16/PC Engine HES emulator
111  Hes_Apu.cpp
112  Hes_Apu.h
113  Hes_Cpu.cpp
114  Hes_Cpu.h
115  hes_cpu_io.h
116  Hes_Emu.cpp
117
118  Kss_Emu.h           MSX Home Computer/other Z80 systems KSS emulator
119  Kss_Emu.cpp
120  Kss_Cpu.cpp
121  Kss_Cpu.h
122  Kss_Scc_Apu.cpp
123  Kss_Scc_Apu.h
124  Ay_Apu.h
125  Ay_Apu.cpp
126  Sms_Apu.h
127  Sms_Apu.cpp
128  Sms_Oscs.h
129
130  Nsf_Emu.h           Nintendo NES NSF/NSFE emulator
131  Nsf_Emu.cpp
132  Nes_Apu.cpp
133  Nes_Apu.h
134  Nes_Cpu.cpp
135  Nes_Cpu.h
136  nes_cpu_io.h
137  Nes_Oscs.cpp
138  Nes_Oscs.h
139  Nes_Fme7_Apu.cpp
140  Nes_Fme7_Apu.h
141  Nes_Namco_Apu.cpp
142  Nes_Namco_Apu.h
143  Nes_Vrc6_Apu.cpp
144  Nes_Vrc6_Apu.h
145  Nsfe_Emu.h          NSFE support
146  Nsfe_Emu.cpp
147
148  Spc_Emu.h           Super Nintendo SPC emulator
149  Spc_Emu.cpp
150  Snes_Spc.cpp
151  Snes_Spc.h
152  Spc_Cpu.cpp
153  Spc_Cpu.h
154  Spc_Dsp.cpp
155  Spc_Dsp.h
156  Fir_Resampler.cpp
157  Fir_Resampler.h
158
159  Sap_Emu.h           Atari SAP emulator
160  Sap_Emu.cpp
161  Sap_Apu.cpp
162  Sap_Apu.h
163  Sap_Cpu.cpp
164  Sap_Cpu.h
165  sap_cpu_io.h
166
167  Vgm_Emu.h           Sega VGM emulator
168  Vgm_Emu_Impl.cpp
169  Vgm_Emu_Impl.h
170  Vgm_Emu.cpp
171  Ym2413_Emu.cpp
172  Ym2413_Emu.h
173  Gym_Emu.h           Sega Genesis GYM emulator
174  Gym_Emu.cpp
175  Sms_Apu.cpp         Common Sega emulator files
176  Sms_Apu.h
177  Sms_Oscs.h
178  Ym2612_Emu.cpp
179  Ym2612_Emu.h
180  Dual_Resampler.cpp
181  Dual_Resampler.h
182  Fir_Resampler.cpp
183  Fir_Resampler.h
184
185  M3u_Playlist.h      M3U playlist support
186  M3u_Playlist.cpp
187
188  Effects_Buffer.h    Sound buffer with stereo echo and panning
189  Effects_Buffer.cpp
190
191  blargg_common.h     Common files needed by all emulators
192  blargg_endian.h
193  blargg_source.h
194  Blip_Buffer.cpp
195  Blip_Buffer.h
196  Gme_File.h
197  Gme_File.cpp
198  Music_Emu.h
199  Music_Emu.cpp
200  Classic_Emu.h
201  Classic_Emu.cpp
202  Multi_Buffer.h
203  Multi_Buffer.cpp
204  Data_Reader.h
205  Data_Reader.cpp
206  
207  CMakeLists.txt      CMake build rules
208
209
210Legal
211-----
212Game_Music_Emu library copyright (C) 2003-2009 Shay Green.
213Sega Genesis YM2612 emulator copyright (C) 2002 Stephane Dallongeville.
214
215--
216Shay Green <gblargg@gmail.com>