# HG changeset patch # User Matti Hamalainen # Date 1092379144 0 # Node ID 78e06aecad7fab686362cd4af33e805ffb656077 # Parent 89844080b44bf61d0f96828018c22856739c9eb1 Updated documentation. diff -r 89844080b44b -r 78e06aecad7f AUTHORS --- a/AUTHORS Thu Aug 12 01:43:03 2004 +0000 +++ b/AUTHORS Fri Aug 13 06:39:04 2004 +0000 @@ -1,6 +1,6 @@ XMMS-SID - SIDPlay input plugin for X MultiMedia System (XMMS) ============================================================== -Matti "ccr/TNSP" Hamalainen - Author and maintainer since v0.5. +Matti "ccr/TNSP" Hamalainen - Author and maintainer Implementation of MD5 (RFC 1321) by L. Peter Deutsch (C) Copyright 1999 Aladdin Enterprises, all rights reserved. diff -r 89844080b44b -r 78e06aecad7f FAQ --- a/FAQ Thu Aug 12 01:43:03 2004 +0000 +++ b/FAQ Fri Aug 13 06:39:04 2004 +0000 @@ -48,7 +48,7 @@ Martin Galway's very famous piece on Arkanoid game was one of the first to feature DIGITIZED SAMPLES like real instruments and speech. ->--- +--- Q: What are "SID-tunes"? @@ -59,11 +59,11 @@ SID-tunes can be created by ripping the music routines and data from some game or just composing the music with some editor. - XMMS-SID is interface, a piece of "software glue", that puts together - several emulator libraries and XMMS allowing play of SID-tunes via - XMMS's interface. + XMMS-SID is interface, a piece of "software glue", that pieces + together several emulator libraries and XMMS, allowing it to + play SID-tunes. ->--- +--- Q: Where to get SID-tunes? @@ -84,7 +84,12 @@ if the tune is a cover and historically interesting facts about games, etc... ->--- + +--- + +Q: + +--- Q: Why isn't the sub-song control window skinned? @@ -93,7 +98,7 @@ skin(s) anyway, piecing a skin together from existing components would probably be impossible in most cases. ->--- +--- Q: When using XMMS-SID with the OpenGL Spectrum Analyzer, the sound becomes distorted! @@ -108,7 +113,7 @@ Try lowering your systemload. Close some unnecessary CPU-consuming applications. Buy faster hardware. ->--- +--- Q: Can I make my own SID-tunes? How? @@ -134,7 +139,7 @@ Rest of that is out of the scope of this document, please don't ask me about this. ->--- +--- Q: XMMS-SID plays some tunes too fast / there are severe playback bugs! @@ -147,7 +152,7 @@ other component. Or it might be in XMMS-SID. Report and I'll see what can be done. ->--- +--- Q: Some tunes are so short that I don't have time to change sub-tune before XMMS moves on to next song in playlist! @@ -156,5 +161,5 @@ (Songlength -tab in configuration dialog) and you have more time to change the sub-tune. ->--- +--- diff -r 89844080b44b -r 78e06aecad7f INSTALL --- a/INSTALL Thu Aug 12 01:43:03 2004 +0000 +++ b/INSTALL Fri Aug 13 06:39:04 2004 +0000 @@ -1,6 +1,6 @@ This document describes overall requirements and procedure for installation of XMMS-SID package, please read it carefully! - +For more tips, please also read README and FAQ. Requirements ============ @@ -8,8 +8,9 @@ - Gtk+ and Glib 1.2.5 or later (http://www.gtk.org/) -- C and C++-compiler. Preferably gcc and g++, I have no idea - whether this compiles with any other compilers ... sorry. +- C and C++-compiler. Preferably GCC along with rest of the + GNU toolchain. I have no idea whether this compiles with + any other compiler ... sorry. - You need AT LEAST one emulation library: @@ -17,9 +18,14 @@ * libSIDPlay2 * NanoSID - Only one is required, but all are supported. You may also - need some supplementary libraries, that are required by - the emulator library. See below for more information. +Only one is required, but all are supported. You may also need +some supplementary libraries, that are required by the emulator +library. See below for more information. + + +NOTICE! Refer to file README for recommendations about which +emulator libraries you should install! + Where to get XMMS? @@ -28,8 +34,10 @@ http://www.xmms.org/ -Please refer to XMMS documentation for information -on it's usage and installation (etc). +Please refer to XMMS documentation for information on its usage +and installation, etc. You probably have XMMS already installed, +but if you installed from a pre-built package, make sure that +you have corresponding xmms-devel -package also. Where to get libSIDPlay1? @@ -48,9 +56,8 @@ http://sidplay2.sourceforge.net/ -You need the "sidplay-libs-2.1.0" package! Earlier versions -WILL NOT WORK! Later versions MAY work, but I can't really -guarantee that. +You need the "sidplay-libs-2.1.0" package! Earlier versions WILL NOT +WORK! Later versions MAY work, but I can't really guarantee that. Where to get NanoSID? @@ -69,23 +76,23 @@ To build a CVS-version of XMMS-SID, you need to have latest (STABLE) versions of following tools installed, including: - - GNU autoconf 2.56 or later - - GNU automake 1.7 or later - - GNU libtool 1.5 or later + - GNU autoconf 2.56 or newer + - GNU automake 1.7 (older and newer versions MAY be incompatible!) + - GNU libtool 1.5 or newer - Glade for Gtk+ 1.2 programs (I use Glade 0.6.4) If you have all required tools installed, just run the -"bootstrap.sh"-script which generates all necessary -build-files. After successfull bootstrapping, you -should be able to install the package normally. +"bootstrap.sh"-script which generates all necessary build-files. +After successfull bootstrapping, you should be able to install +the package normally, following steps described in next chapter. Installing XMMS-SID =================== -When you have the requirements installed and working -succesfully, you can try compiling XMMS-SID. +When you have the requirements installed and working succesfully, +you may try compiling and installation of XMMS-SID. -Invoke configure-script (use parameter --help for help) +Invoke configure script (use parameter --help for help) $ ./configure diff -r 89844080b44b -r 78e06aecad7f README --- a/README Thu Aug 12 01:43:03 2004 +0000 +++ b/README Fri Aug 13 06:39:04 2004 +0000 @@ -18,11 +18,58 @@ engines, including the excellent libSIDPlay v1 and v2. -Requirements and installation -============================= -See file "INSTALL" for information about what XMMS-SID requires, +Installation requirements and recommendations +============================================= +Refer to file "INSTALL" for information about what XMMS-SID requires, where to get those required packages and how to install. +Some words on which emulation library you should select - it depends +somewhat on your system and personal preferences. + + +- libSIDPlay v1: This is the old SIDPlay v1 emulation library. Its + emulation is "frame-based" and not very accurate. The waveforms + produced are harsher and emulation if SID filter is far from + accurate. + + libSIDPlay v1 requires very little CPU power, it is faster and + may have fewer bugs due to being more mature software. Many + distributions have pre-built packages of it, not something that + can be said of libSIDPlay v2. Some people may even like the + harsher sound produced by libSIDPlay v1. + + Drawbacks are: worse emulation, eventually weakening compability + as new SID-tunes/files are ripped into "RSID"-format which + libSIDPlay v1 does NOT support. + + +- libSIDPlay v2: New, next generation modular SID-emulation framework. + Along with reSID-library it produces probably most accurate emulated + representation of SID-chip available. This, however, comes at high + cost: libSIDPlay2 tends to eat CPU like popcorn, depending on the + selected emulation options. It is also less spread, not as many + distributions/operating systems come with pre-packaged libSIDPlay2, + so you may have to roll your own. + + Also the API-stability of libSIDPlay2 is not yet 100%, there may + be changes. Bugs are evident, though many of them will be fixed + eventually. + + +- libNanoSID: An obscure binary-only emulation library which only plays + special ZSID-format files, which are not compatible with PSID-formats. + Pros: Fast emulation, supposedly good filter-emulation. + Cons: Does not support normal PSID-files directly, binary-only library + which only works on x86-Linux architechture. + + +Conclusion thus is as follows: If you are using an old system with not +much spare CPU-power, choose libSIDPlay v1. On a new system (more +powerful than Pentium III 650MHz at least) you may choose libSIDPlay v2. + +libNanoSID is for those who need support for ZSID-format, most people +don't have any reason to concern themselves with it. + Usage ===== diff -r 89844080b44b -r 78e06aecad7f TODO --- a/TODO Thu Aug 12 01:43:03 2004 +0000 +++ b/TODO Fri Aug 13 06:39:04 2004 +0000 @@ -2,23 +2,18 @@ ============================================================== For XMMS-SID v0.9/1.0 - -Minor - -- Quick key/button/something to toggle: - - NTSC/PAL - - 6581/8580 - - Playtime checks (sldb/max) - -Major - +--------------------- - Editing facilities in song-info? - Possibly: Song "pre-rendering" support+position selector work like it "should". Option for those who have the CPU power (or patience) and enough RAM to spare for - the whole song. + the whole song. (probably not feasible) - What about "pre-rendering" of next playlist item during - playing of current one? Would it be possible? + playing of current one? (probably impossible) + +For XMMS-SID2 +------------- +Port to XMMS2.