ViewVC Help
View File | Revision Log | Show Annotations | Revision Graph | Root Listing
root/cebix/SIDPlayer/README
(Generate patch)

Comparing SIDPlayer/README (file contents):
Revision 1.2 by cebix, 2000-09-18T22:02:54Z vs.
Revision 1.14 by cebix, 2001-01-22T17:20:12Z

# Line 1 | Line 1
1  
2 <        SIDPlayer, Version 4.0
2 >  SIDPlayer, Version 4.2
3 >  A SID tune replayer
4  
5 <        A SID tune replayer for BeOS
5 <
6 <        Copyright (C) 1996-2000 Christian Bauer
7 <        Freely distributable
5 >  Copyright (C) 1996-2001 Christian Bauer
6  
7  
8   License
# Line 17 | Line 15 | See the file "COPYING" that is included
15   What is SIDPlayer?
16   ------------------
17  
18 < SIDPlayer is a replayer program for C64 music ("SID tunes"), like PlaySID
19 < on the Amiga or SIDPLAY for Unix. You can think of it as being a stripped-
20 < down C64 emulator that only emulates the CPU and the sound chip of the
21 < C64. SIDPlayer can replay SID tunes in the "PSID" file format, but it
22 < cannot run any C64 programs.
18 > SIDPlayer is a replayer program for C64 music ("SID tunes"), like PlaySID on
19 > the Amiga or SIDPLAY for Unix. You can think of it as being a stripped-down
20 > C64 emulator that only emulates the CPU and the sound chip of the C64.
21 > SIDPlayer can replay SID tunes in the "PSID" file format, but it cannot run
22 > any C64 programs.
23  
24  
25   Why would I want to listen to C64 music?
# Line 34 | Line 32 | sound chip (called "SID" - "Sound Interf
32   computers (as the Atari ST or the first Macs) had worse sound.
33  
34   The SID chip features three oscillators with selectable waveform, ADSR
35 < envelope generators, programmable resonance filters and special effects
36 < like ring modulation. With the aid of the CPU, it can also replay 4-bit
37 < sampled sounds. SIDPlayer emulates all features of the SID chip, including
38 < the filters.
35 > envelope generators, programmable resonance filters and special effects like
36 > ring modulation. With the aid of the CPU, it can also replay 4-bit sampled
37 > sounds. SIDPlayer emulates all features of the SID chip, including the
38 > filters.
39  
40   There were (and are still) many composers programming excellent music for
41   the C64 and thousands of tunes have been converted for use with SID tune
# Line 46 | Line 44 | SID tunes is that they take very little
44   in size.
45  
46  
47 + System Requirements
48 + -------------------
49 +
50 + SIDPlayer runs on all Unix systems supported by SDL (which includes Linux,
51 + FreeBSD, Solaris and Irix) and on BeOS R4.5 or later versions.
52 +
53 + Successfully tested systems include:
54 + - Linux/i386
55 + - BeOS/x86 R5
56 + - BeOS/ppc R4.5
57 +
58 +
59   Supported file formats
60   ----------------------
61  
# Line 54 | Line 64 | files (these have the signature "PSID" i
64   available on the Internet is in this format.
65  
66  
67 < Using SIDPlayer
68 < ---------------
67 > Installing SIDPlayer
68 > --------------------
69 >
70 > See the file "INSTALL".
71  
60 SIDPlayer can be started from the Tracker or from the Shell. If you give
61 the name of a PSID file as an argument from the Shell or drag a PSID file
62 onto the SIDPlayer icon from the Tracker, that file is loaded and played.
63
64 The SIDPlayer window some information about the currently loaded PSID file
65 and has the usual tapedeck-like controls for pausing, restarting and
66 stopping the replay and for selecting the next or previous song contained
67 in the PSID file. The number of the song currently playing and the total
68 number of songs in the loaded PSID file are displayed to the right of the
69 tapedeck buttons. The slider in the bottom right of the window can be used
70 to adjust the replay speed.
72  
73 < Clicking and holding the right mouse button in the SIDPlayer window will show
74 < a pop-up menu with three items:
73 > Using SIDPlayer under BeOS
74 > --------------------------
75 >
76 > SIDPlayer can be started from the Tracker or from the Shell. If you give the
77 > name of a PSID file as an argument from the Shell or drag a PSID file onto
78 > the SIDPlayer icon from the Tracker, that file is loaded and played.
79 >
80 > The SIDPlayer window displays some information about the currently loaded
81 > PSID file and has the usual tapedeck-like controls for pausing, restarting
82 > and stopping the replay and for selecting the next or previous song
83 > contained in the PSID file. The number of the song currently playing and the
84 > total number of songs in the loaded PSID file are displayed to the right of
85 > the tapedeck buttons. The slider in the bottom right of the window can be
86 > used to adjust the replay speed.
87 >
88 > The SIDPlayer menu has three items:
89  
90   - "About SIDPlayer" shows some information about SIDPlayer
91 < - "Sound Control" opens the sound control window
91 > - "Sound Control" opens the sound control window (see below)
92   - "Quit" quits SIDPlayer
93  
94   To load another PSID file, drag it into the SIDPlayer window. To quit
# Line 88 | Line 103 | Some functions of SIDPlayer can also be
103    Right arrow: Next song
104    Q          : Quit
105  
91 SIDPlayer can also be used as an input plugin for CL-Amp by Claes Löfqvist.
92 Simply copy the program to your CL-Amp "Plugins" directory (you have to copy
93 it, placing a link won't work) and rename it to "in_SIDPlayer".
106  
107 + Using SIDPlayer under Unix
108 + --------------------------
109 +
110 + SIDPlayer currently only works as a command-line application. It is invoked
111 + as follows:
112 +
113 +  sidplayer FILE [song_number]
114 +
115 + "FILE" is the name of the PSID file to be loaded. The optional "song_number"
116 + specifies the number of the song to be player (instead of the default song).
117 + SIDPlayer cannot detect when a song has finished, so you have to use Ctrl-C
118 + to quit it.
119  
120 < The Sound Control window
121 < ------------------------
120 >
121 > The Sound Control window (BeOS only)
122 > ------------------------------------
123 >
124 > Sound post-processing is controlled with the "Effect" pop-up menu and the
125 > "Delay" and "Feedback" sliders. The available effects are "None" (no post-
126 > processing), "Reverb" (simple reverb) and "Spatial" (reverb with phase
127 > shift, intended for headphone users).
128  
129   The checkbox labeled "Filters" is used to turn the emulation of the SID
130   filters on or off.
131  
132 < The eight slider gadgets in the right part of the window control the
133 < stereo panning and volume of each of the four voices (3 synthesized
134 < voices, 1 sampled voice).
132 > The "New SID Chip" checkbox selects the type of SID chip to be emulated.
133 > Currently this only affects some combined waveforms.
134 >
135 > The eight slider gadgets in the right part of the window control the stereo
136 > panning and volume of each of the four voices (3 synthesized voices, 1
137 > sampled voice).
138  
139  
140   Where do I get PSID files
141   -------------------------
142  
143   The two largest collections of SID tunes are the "High Voltage" SID
144 < Collection (http://www.dhp.com/~shark/c64music) and the "NemeSIDs"
145 < archive (ftp://frodo.hiof.no/pub/c64/sidmusic). These have been used
146 < for testing during the development of SIDPlayer and they should all work.
144 > Collection (http://hvsc.c64.org) and the "NemeSIDs" archive
145 > (ftp://frodo.hiof.no/pub/c64/sidmusic). These have been used for testing
146 > during the development of SIDPlayer and they should all work.
147  
148 < Twenty demonstration SID tunes are included with SIDPlayer in the
149 < "PSID Demo" directory.
148 > Twenty demonstration SID tunes are included with SIDPlayer in the "PSID
149 > Demo" directory.
150 >
151 >
152 > Support
153 > -------
154 >
155 > Updates of SIDPlayer are available on the official SIDPlayer home page:
156 >
157 >  http://www.uni-mainz.de/~bauec002/SPMain.html
158  
159  
160   History
# Line 137 | Line 178 | V4.0 - Now based on Frodo V5 CPU/SID cod
178         faster/slower buttons by slider, added popup menu and sound control
179         window, ported to BeOS R5 with new Media Kit, implemented CIA timer
180         speed control, and SIDPlayer can now also be used as a CL-Amp plugin
181 + V4.1 - Runs as a command-line application under Unix (requiring SDL),
182 +       preferences items can be passed on the command line, and SIDPlayer
183 +       can now also be used as a SoundPlay plugin
184 + V4.2 - Fixed writes to mirrored SID registers
185 +
186 +
187 + Acknowledgements
188 + ----------------
189 +
190 + Special thanks go to Claes Lfqvist and Marco Nelissen for their help with
191 + adding CL-Amp and SoundPlay plugin support.
192  
193  
194   Christian Bauer

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines