annotate Plugins/Input/console/gme_readme.txt @ 493:c04dff121e1d trunk

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