/readme.txt

http://game-music-emu.googlecode.com/ · Plain Text · 216 lines · 184 code · 32 blank · 0 comment · 0 complexity · 858ac6b29fcfdcb59eb2a77375c0e716 MD5 · raw file

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