comparison src/console/gme_readme.txt @ 12:3da1b8942b8b trunk

[svn] - remove src/Input src/Output src/Effect src/General src/Visualization src/Container
author nenolod
date Mon, 18 Sep 2006 03:14:20 -0700
parents src/Input/console/gme_readme.txt@13389e613d67
children fb513e10174e
comparison
equal deleted inserted replaced
11:cff1d04026ae 12:3da1b8942b8b
1 Game_Music_Emu 0.3.0: Game Music Emulators
2 ------------------------------------------
3 Game_Music_Emu is a collection of portable video game music emulators. Its
4 modular design allows elimination of any unneeded emulators and features.
5 Modules are included supporting the following file formats:
6
7 GBS Nintendo Game Boy
8 VGM/VGZ Sega Master System/Genesis/Mega Drive/Mark III/BBC Micro
9 GYM Sega Genesis
10 SPC Super Nintendo
11 NSF Nintendo NES (with VRC6, N106, and FME-7 sound)
12
13 This library has been used in game music players for Win32, Linux x86-32/64,
14 Mac OS X, Mac OS Classic, MorphOS (Amiga), PlayStation Portable, and GP2X.
15
16 Author : Shay Green <hotpop.com@blargg>
17 Website: http://www.slack.net/~ant/
18 Forum : http://groups.google.com/group/blargg-sound-libs
19 License: GNU Lesser General Public License (LGPL)
20
21
22 Getting Started
23 ---------------
24 Build a program consisting of demo/basics.cpp, demo/Wave_Writer.cpp, and all
25 source files in gme/ except Gzip_File.cpp. Be sure "test.nsf" is in the same
26 directory. Running the program should generate a WAVE sound file "out.wav" of
27 music.
28
29 See notes.txt for more information, and respective header (.h) files for
30 reference. Post to the discussion forum for assistance.
31
32
33 Files
34 -----
35 notes.txt General notes about the library
36 changes.txt Changes made since previous releases
37 design.txt Library design notes
38 LGPL.txt GNU Lesser General Public License
39
40 test.nsf Test file for NSF emulator
41
42 demo/
43 basics.cpp Loads game music file and records to wave sound file
44 info_fields.cpp Reads information tags from files
45 multi_format.cpp Handles multiple game music types
46 custom_reader.cpp Loads music data from gzip file and memory block
47 stereo_effects.cpp Uses Effects_Buffer to add stereo echo
48
49 simple_player.cpp Uses Music_Player to make simple player
50 Music_Player.cpp Simple game music player module using SDL sound
51 Music_Player.h
52
53 Wave_Writer.h WAVE sound file writer used for demo output
54 Wave_Writer.cpp
55
56 gme/
57 Effects_Buffer.h Sound buffer with adjustable stereo echo and panning
58 Effects_Buffer.cpp
59
60 Gzip_File.h Gzip reader for transparent access to gzipped files
61 Gzip_File.cpp
62
63 Music_Emu.h Game music emulator interface
64
65 Nsf_Emu.h Nintendo NES NSF emulator
66 Nsf_Emu.cpp
67 Nes_Apu.cpp
68 Nes_Apu.h
69 Nes_Cpu.cpp
70 Nes_Cpu.h
71 Nes_Oscs.cpp
72 Nes_Oscs.h
73 Nes_Fme7_Apu.cpp
74 Nes_Fme7_Apu.h
75 Nes_Namco_Apu.cpp
76 Nes_Namco_Apu.h
77 Nes_Vrc6_Apu.cpp
78 Nes_Vrc6_Apu.h
79
80 Gbs_Emu.h Nintendo Game Boy GBS emulator
81 Gbs_Emu.cpp
82 Gb_Apu.cpp
83 Gb_Apu.h
84 Gb_Cpu.cpp
85 Gb_Cpu.h
86 Gb_Oscs.cpp
87 Gb_Oscs.h
88
89 Spc_Emu.h Super Nintendo SPC emulator
90 Spc_Emu.cpp
91 Snes_Spc.cpp
92 Snes_Spc.h
93 Spc_Cpu.cpp
94 Spc_Cpu.h
95 Spc_Dsp.cpp
96 Spc_Dsp.h
97 Fir_Resampler.cpp
98 Fir_Resampler.h
99
100 Gym_Emu.h Sega Genesis GYM emulator
101 Gym_Emu.cpp
102 Vgm_Emu.h Sega VGM emulator
103 Vgm_Emu_Impl.cpp
104 Vgm_Emu_Impl.h
105 Vgm_Emu.cpp
106 Ym2413_Emu.cpp
107 Ym2413_Emu.h
108 Sms_Apu.cpp Common Sega emulator files
109 Sms_Apu.h
110 Sms_Oscs.h
111 Ym2612_Emu.cpp
112 Ym2612_Emu.h
113 Dual_Resampler.cpp
114 Dual_Resampler.h
115 Fir_Resampler.cpp
116 Fir_Resampler.h
117
118 blargg_common.h Common files
119 blargg_endian.h
120 blargg_source.h
121 Blip_Buffer.cpp
122 Blip_Buffer.h
123 Music_Emu.cpp
124 Classic_Emu.h
125 Classic_Emu.cpp
126 Multi_Buffer.h
127 Multi_Buffer.cpp
128 abstract_file.cpp
129 abstract_file.h
130
131
132 Legal
133 -----
134 Game_Music_Emu library copyright (C) 2003-2006 Shay Green.
135 SNES SPC DSP emulator based on OpenSPC, copyright (C) 2002 Brad Martin.
136 Sega Genesis YM2612 emulator copyright (C) 2002 Stephane Dallongeville.