/[cebix]/SIDPlayer/README
ViewVC logotype

Diff of /SIDPlayer/README

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.1.1.1 by cebix, 2000-07-28T12:42:28Z revision 1.19 by cebix, 2004-01-12T15:15:48Z
# Line 1  Line 1 
1    
2          SIDPlayer, Version 4.0    SIDPlayer
3      A SID tune replayer
4    
5          A SID tune replayer for BeOS    Copyright (C) 1996-2004 Christian Bauer
   
         Copyright (C) 1996-2000 Christian Bauer  
         Freely distributable  
6    
7    
8  License  License
# Line 17  See the file "COPYING" that is included Line 15  See the file "COPYING" that is included
15  What is SIDPlayer?  What is SIDPlayer?
16  ------------------  ------------------
17    
18  SIDPlayer is a replayer program for C64 music ("SID tunes"), like PlaySID  SIDPlayer is a replayer program for C64 music ("SID tunes"), like PlaySID on
19  on the Amiga or SIDPLAY for Unix. You can think of it as being a stripped-  the Amiga or SIDPLAY for Unix. You can think of it as being a stripped-down
20  down C64 emulator that only emulates the CPU and the sound chip of the  C64 emulator that only emulates the CPU and the sound chip of the C64.
21  C64. SIDPlayer can replay SID tunes in the "PSID" file format, but it  SIDPlayer can replay SID tunes in the "PSID" file format, but it cannot run
22  cannot run any C64 programs.  any C64 programs.
23    
24    
25  Why would I want to listen to C64 music?  Why would I want to listen to C64 music?
# Line 34  sound chip (called "SID" - "Sound Interf Line 32  sound chip (called "SID" - "Sound Interf
32  computers (as the Atari ST or the first Macs) had worse sound.  computers (as the Atari ST or the first Macs) had worse sound.
33    
34  The SID chip features three oscillators with selectable waveform, ADSR  The SID chip features three oscillators with selectable waveform, ADSR
35  envelope generators, programmable resonance filters and special effects  envelope generators, programmable resonance filters and special effects like
36  like ring modulation. With the aid of the CPU, it can also replay 4-bit  ring modulation. With the aid of the CPU, it can also replay 4-bit sampled
37  sampled sounds. SIDPlayer emulates all features of the SID chip, including  sounds. SIDPlayer emulates all features of the SID chip, including the
38  the filters.  filters.
39    
40  There were (and are still) many composers programming excellent music for  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  the C64 and thousands of tunes have been converted for use with SID tune
# Line 46  SID tunes is that they take very little Line 44  SID tunes is that they take very little
44  in size.  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 R5
57    
58    
59  Supported file formats  Supported file formats
60  ----------------------  ----------------------
61    
# Line 54  files (these have the signature "PSID" i Line 64  files (these have the signature "PSID" i
64  available on the Internet is in this format.  available on the Internet is in this format.
65    
66    
67  Using SIDPlayer  Installing SIDPlayer
68  ---------------  --------------------
69    
70    See the file "INSTALL".
71    
72    
73  SIDPlayer can be started from the Tracker or from the Shell. If you give  Using SIDPlayer under BeOS
74  the name of a PSID file as an argument from the Shell or drag a PSID file  --------------------------
 onto the SIDPlayer icon from the Tracker, that file is loaded and played.  
   
 The SIDPlayer window some information about the currently loaded PSID file  
 and has the usual tapedeck-like controls for pausing, restarting and  
 stopping the replay and for selecting the next or previous song contained  
 in the PSID file. The number of the song currently playing and the total  
 number of songs in the loaded PSID file are displayed to the right of the  
 tapedeck buttons. The slider in the bottom right of the window can be used  
 to adjust the replay speed.  
75    
76  Clicking and holding the right mouse button in the SIDPlayer window will show  SIDPlayer can be started from the Tracker or from the Shell. If you give the
77  a pop-up menu with three items:  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   - "About SIDPlayer" shows some information about SIDPlayer
91   - "Sound Control" opens the sound control window   - "Sound Control" opens the sound control window (see below)
92   - "Quit" quits SIDPlayer   - "Quit" quits SIDPlayer
93    
94  To load another PSID file, drag it into the SIDPlayer window. To quit  To load another PSID file, drag it into the SIDPlayer window. To quit
# Line 88  Some functions of SIDPlayer can also be Line 103  Some functions of SIDPlayer can also be
103    Right arrow: Next song    Right arrow: Next song
104    Q          : Quit    Q          : Quit
105    
 SIDPlayer can also be used as an input plugin for CL-Amp by Claes Löfqvist.  
 Simply copy the program to your CL-Amp "Plugins" directory (you have to copy  
 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    SIDPlayer accepts a number of command line arguments. Type "sidplayer --help"
121    to get a list.
122    
123  The Sound Control window  If you have a Catweasel MK3 PCI card with a SID chip installed you can
124  ------------------------  redirect the output of SIDPlayer to the card by specifying the "--cwsid on"
125    command line argument. Visit www.jschoenfeld.de for more information about
126    the Catweasel card.
127    
128    
129    The Sound Control window (BeOS only)
130    ------------------------------------
131    
132    Sound post-processing is controlled with the "Effect" pop-up menu and the
133    "Delay" and "Feedback" sliders. The available effects are "None" (no post-
134    processing), "Reverb" (simple reverb) and "Spatial" (reverb with phase
135    shift, intended for headphone users).
136    
137  The checkbox labeled "Filters" is used to turn the emulation of the SID  The checkbox labeled "Filters" is used to turn the emulation of the SID
138  filters on or off.  filters on or off.
139    
140  The eight slider gadgets in the right part of the window control the  The "New SID Chip" checkbox selects the type of SID chip to be emulated.
141  stereo panning and volume of each of the four voices (3 sythesized  Currently this only affects some combined waveforms.
142  voices, 1 sampled voice).  
143    The eight slider gadgets in the right part of the window control the stereo
144    panning and volume of each of the four voices (3 synthesized voices, 1
145    sampled voice).
146    
147    
148  Where do I get PSID files  Where do I get PSID files
149  -------------------------  -------------------------
150    
151  The two largest collections of SID tunes are the "High Voltage" SID  The two largest collections of SID tunes are the "High Voltage" SID
152  Collection (http://www.dhp.com/~shark/c64music) and the "NemeSIDs"  Collection (http://hvsc.c64.org) and the "NemeSIDs" archive
153  archive (ftp://frodo.hiof.no/pub/c64/sidmusic). These have been used  (ftp://frodo.hiof.no/pub/c64/sidmusic). These have been used for testing
154  for testing during the development of SIDPlayer and they should all work.  during the development of SIDPlayer and they should all work.
155    
156    Twenty demonstration SID tunes are included with SIDPlayer in the "PSID
157    Demo" directory.
158    
159    
160  Twelve demonstration SID tunes are included with SIDPlayer in the  Support
161  "PSID Demo" directory.  -------
162    
163    Updates of SIDPlayer are available on the official SIDPlayer home page:
164    
165      http://www.uni-mainz.de/~bauec002/SPMain.html
166    
167    
168  History  History
# Line 137  V4.0 - Now based on Frodo V5 CPU/SID cod Line 186  V4.0 - Now based on Frodo V5 CPU/SID cod
186         faster/slower buttons by slider, added popup menu and sound control         faster/slower buttons by slider, added popup menu and sound control
187         window, ported to BeOS R5 with new Media Kit, implemented CIA timer         window, ported to BeOS R5 with new Media Kit, implemented CIA timer
188         speed control, and SIDPlayer can now also be used as a CL-Amp plugin         speed control, and SIDPlayer can now also be used as a CL-Amp plugin
189    V4.1 - Runs as a command line application under Unix (requiring SDL),
190           preferences items can be passed on the command line, and SIDPlayer
191           can now also be used as a SoundPlay plugin
192    V4.2 - Fixed writes to mirrored SID registers, output to WAV file is possible
193           in SDL version
194    V4.3 - Added support for Catweasel SID hardware in SDL version (use option
195           "--cwsid on"), CIA timer speed control now actually works
196    V4.4 - Fixed a problem with the wrong replay routine being called when the
197           IRQ vector was changed. Mastercomposer tunes (and probably others)
198           not play correctly. [Thanks to Stefano Tognon.]
199    
200    
201    Acknowledgements
202    ----------------
203    
204    Special thanks go to Claes Lfqvist and Marco Nelissen for their help with
205    adding CL-Amp and SoundPlay plugin support.
206    
207    
208  Christian Bauer  Christian Bauer

Legend:
Removed from v.1.1.1.1  
changed lines
  Added in v.1.19

  ViewVC Help
Powered by ViewVC 1.1.27