comparison README @ 171:78e06aecad7f

Updated documentation.
author Matti Hamalainen <ccr@tnsp.org>
date Fri, 13 Aug 2004 06:39:04 +0000
parents d3425d53be3a
children 7515712b4af7
comparison
equal deleted inserted replaced
170:89844080b44b 171:78e06aecad7f
16 16
17 For the actual playing, XMMS-SID supports numerous emulator 17 For the actual playing, XMMS-SID supports numerous emulator
18 engines, including the excellent libSIDPlay v1 and v2. 18 engines, including the excellent libSIDPlay v1 and v2.
19 19
20 20
21 Requirements and installation 21 Installation requirements and recommendations
22 ============================= 22 =============================================
23 See file "INSTALL" for information about what XMMS-SID requires, 23 Refer to file "INSTALL" for information about what XMMS-SID requires,
24 where to get those required packages and how to install. 24 where to get those required packages and how to install.
25
26 Some words on which emulation library you should select - it depends
27 somewhat on your system and personal preferences.
28
29
30 - libSIDPlay v1: This is the old SIDPlay v1 emulation library. Its
31 emulation is "frame-based" and not very accurate. The waveforms
32 produced are harsher and emulation if SID filter is far from
33 accurate.
34
35 libSIDPlay v1 requires very little CPU power, it is faster and
36 may have fewer bugs due to being more mature software. Many
37 distributions have pre-built packages of it, not something that
38 can be said of libSIDPlay v2. Some people may even like the
39 harsher sound produced by libSIDPlay v1.
40
41 Drawbacks are: worse emulation, eventually weakening compability
42 as new SID-tunes/files are ripped into "RSID"-format which
43 libSIDPlay v1 does NOT support.
44
45
46 - libSIDPlay v2: New, next generation modular SID-emulation framework.
47 Along with reSID-library it produces probably most accurate emulated
48 representation of SID-chip available. This, however, comes at high
49 cost: libSIDPlay2 tends to eat CPU like popcorn, depending on the
50 selected emulation options. It is also less spread, not as many
51 distributions/operating systems come with pre-packaged libSIDPlay2,
52 so you may have to roll your own.
53
54 Also the API-stability of libSIDPlay2 is not yet 100%, there may
55 be changes. Bugs are evident, though many of them will be fixed
56 eventually.
57
58
59 - libNanoSID: An obscure binary-only emulation library which only plays
60 special ZSID-format files, which are not compatible with PSID-formats.
61 Pros: Fast emulation, supposedly good filter-emulation.
62 Cons: Does not support normal PSID-files directly, binary-only library
63 which only works on x86-Linux architechture.
64
65
66 Conclusion thus is as follows: If you are using an old system with not
67 much spare CPU-power, choose libSIDPlay v1. On a new system (more
68 powerful than Pentium III 650MHz at least) you may choose libSIDPlay v2.
69
70 libNanoSID is for those who need support for ZSID-format, most people
71 don't have any reason to concern themselves with it.
25 72
26 73
27 Usage 74 Usage
28 ===== 75 =====
29 Using the plugin is quite simple: if you are familiar with XMMS and 76 Using the plugin is quite simple: if you are familiar with XMMS and